Get Balance

Get Balance

curl --request GET \
  --url https://api.pro.daya.co/public/v1/balances/{currency} \
  --header 'X-Api-Key: <x-api-key>'

import requests

url = "https://api.pro.daya.co/public/v1/balances/{currency}"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://api.pro.daya.co/public/v1/balances/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pro.daya.co/public/v1/balances/{currency}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pro.daya.co/public/v1/balances/{currency}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pro.daya.co/public/v1/balances/{currency}")
  .header("X-Api-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pro.daya.co/public/v1/balances/{currency}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

GET

public

balances

{currency}

Get Balance

curl --request GET \
  --url https://api.pro.daya.co/public/v1/balances/{currency} \
  --header 'X-Api-Key: <x-api-key>'

import requests

url = "https://api.pro.daya.co/public/v1/balances/{currency}"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://api.pro.daya.co/public/v1/balances/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pro.daya.co/public/v1/balances/{currency}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pro.daya.co/public/v1/balances/{currency}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pro.daya.co/public/v1/balances/{currency}")
  .header("X-Api-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pro.daya.co/public/v1/balances/{currency}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "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

string

required

Your API key with Read scope

X-Api-Key: daya_sk_YOUR_API_KEY

Path Parameters

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'

const currency = 'USD';

const response = await fetch(
  `https://api.pro.daya.co/public/v1/balances/${currency}`,
  {
    headers: {
      'X-Api-Key': 'daya_sk_YOUR_API_KEY'
    }
  }
);

const result = await response.json();
console.log(result.data);

import requests

currency = 'USD'
headers = {
    'X-Api-Key': 'daya_sk_YOUR_API_KEY'
}

response = requests.get(
    f'https://api.pro.daya.co/public/v1/balances/{currency}',
    headers=headers
)

result = response.json()
print(result['data'])

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    currency := "USD"
    url := fmt.Sprintf("https://api.pro.daya.co/public/v1/balances/%s", currency)

    client := &http.Client{}
    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Add("X-Api-Key", "daya_sk_YOUR_API_KEY")

    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var data map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&data)
    fmt.Println(data["data"])
}

Response

boolean

required

Indicates if the request was successful

string

required

Human-readable response message

object

required

Balance object

Show balance properties

string

Currency codeExample: USD

string

Total balance (available + held)Example: 1500.00

string

Available balance (can be used for trading)Example: 1000.00

string

Held balance (locked in open orders)Example: 500.00

string

Outstanding credit debtExample: 0.00

string

Credit held in open ordersExample: 0.00

string

Available credit to useExample: 0.00

string

Total credit limitExample: 0.00

string

Current USD exchange rate for this currencyExample: 1.00

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

Get Balances Place Order

Getting Started

Markets

Account

Orders

Trades

Deposits

Withdrawals

Webhooks API

Webhooks

Overview

Authentication

Path Parameters

Request Examples

Response

Success Response

Error Responses

401 Unauthorized

403 Forbidden

404 Not Found

Rate Limits

Next Steps

Get Balances

Place Order

​Overview

​Authentication

​Path Parameters

​Request Examples

​Response

​Success Response

​Error Responses

​401 Unauthorized

​403 Forbidden

​404 Not Found

​Rate Limits

​Next Steps

Get Balances

Place Order

Overview

Authentication

Path Parameters

Request Examples

Response

Success Response

Error Responses

401 Unauthorized

403 Forbidden

404 Not Found

Rate Limits

Next Steps