Skip to main content
GET
/
public
/
v1
/
balances
/
{currency}
Get Balance
curl --request GET \
  --url https://api.pro.daya.co/public/v1/balances/{currency} \
  --header 'X-Api-Key: <x-api-key>'
{
  "success": true,
  "message": "Balance retrieved successfully",
  "data": {
    "currency": "USD",
    "total_balance": "1500.00",
    "available_balance": "1000.00",
    "held_balance": "500.00",
    "used_credit": "0.00",
    "held_credit": "0.00",
    "available_credit": "0.00",
    "credit_limit": "0.00",
    "usd_rate": "1.00"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Overview

Get the current balance for a specific currency in your Pro account. This endpoint requires authentication with an API key that has Read scope.
Unified Balance: USDT, USDC, and USD are all mapped to a single unified USD balance. Use USD to retrieve your dollar balance.

​
Authentication

​
X-Api-Key
string
required
Your API key with Read scope
X-Api-Key: daya_sk_YOUR_API_KEY

​
Path Parameters

​
currency
string
required
Currency code to retrieve balance forExample: USD, NGN

​
Request Examples

curl --request GET \
  --url https://api.pro.daya.co/public/v1/balances/USD \
  --header 'X-Api-Key: daya_sk_YOUR_API_KEY'

​
Response

​
success
boolean
required
Indicates if the request was successful
​
message
string
required
Human-readable response message
​
data
object
required
Balance object
​
timestamp
string
ISO 8601 timestamp of the response

​
Success Response

{
  "success": true,
  "message": "Balance retrieved successfully",
  "data": {
    "currency": "USD",
    "total_balance": "1500.00",
    "available_balance": "1000.00",
    "held_balance": "500.00",
    "used_credit": "0.00",
    "held_credit": "0.00",
    "available_credit": "0.00",
    "credit_limit": "0.00",
    "usd_rate": "1.00"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Error Responses

​
401 Unauthorized

{
  "success": false,
  "message": "Unauthorized",
  "error": {
    "code": "API_KEY_INVALID",
    "message": "Invalid or missing API key"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}
Common causes:
  • Missing X-Api-Key header
  • Invalid API key format
  • API key has been revoked

​
403 Forbidden

{
  "success": false,
  "message": "Forbidden",
  "error": {
    "code": "API_KEY_INVALID_SCOPE",
    "message": "Insufficient scope for this operation"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}
Common causes:
  • API key does not have Read scope
  • User account is suspended

​
404 Not Found

{
  "success": false,
  "message": "Currency not found",
  "error": {
    "code": "NOT_FOUND",
    "message": "The specified currency does not exist"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}
Common causes:
  • Invalid currency code
  • Currency not supported on the platform

​
Rate Limits

  • 100 requests per minute per API key
  • Requires Read scope

​
Next Steps

Get Balances

Get all currency balances at once

Place Order

Use your balance to place trades