Trade Balance API

GET Endpoint

https://api.apiverve.com/v1/tradebalance

Code Examples

Here are examples of how to call the Trade Balance API in different programming languages:

curl -X GET \
  "https://api.apiverve.com/v1/tradebalance" \
  -H "X-API-Key: your_api_key_here"

const response = await fetch('https://api.apiverve.com/v1/tradebalance', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

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

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/tradebalance', headers=headers)

data = response.json()
print(data)

const https = require('https');
const url = require('url');

const options = {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const req = https.request('https://api.apiverve.com/v1/tradebalance', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.end();

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/tradebalance');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>

package main

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

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/tradebalance", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

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

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/tradebalance')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var response = await client.GetAsync("https://api.apiverve.com/v1/tradebalance");
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Trade Balance API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Trade Balance API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Trade Balance API:

Response

The Trade Balance API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

{
  "status": "ok",
  "error": null,
  "data": {
    "yearMonth": "2024-01",
    "year": 2024,
    "month": 1,
    "customsDuties": 8234567890,
    "updatedAt": "2024-02-01T00:00:00.000Z"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <yearMonth>2024-01</yearMonth>
    <year>2024</year>
    <month>1</month>
    <customsDuties>8234567890</customsDuties>
    <updatedAt>2024-02-01T00:00:00.000Z</updatedAt>
  </data>
</response>

status: ok
error: null
data:
  yearMonth: 2024-01
  year: 2024
  month: 1
  customsDuties: 8234567890
  updatedAt: '2024-02-01T00:00:00.000Z'

Response Structure

All API responses follow a consistent structure with the following fields:

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Headers

Required and optional headers for Trade Balance API requests:

Learn more about request headers →

GraphQL AccessALPHA

Access Trade Balance through GraphQL to combine it with other API calls in a single request. Query only the trade balance data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  tradebalance(
    input: {
      date: "2024-01"
    }
  ) {
    yearMonth
    year
    month
    customsDuties
    updatedAt
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Trade Balance API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Trade Balance directly from browser-based applications without proxy servers.

Browser Usage: You can call Trade Balance directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Trade Balance API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Trade Balance users.

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Trade Balance response includes headers to help you track your usage:

Handling Rate Limits

Free Plan: When you exceed your rate limit, Trade Balance returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Trade Balance:

• Monitor the rate limit headers to track your Trade Balance usage (Free plan only)
• Cache trade balance responses where appropriate to reduce API calls
• Upgrade to Pro or Mega for guaranteed no-throttle Trade Balance performance

Note: Trade Balance rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Trade Balance on Free tier.

Error Codes

The Trade Balance API uses standard HTTP status codes to indicate success or failure:

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Trade Balance with SDKs

Get started quickly with official Trade Balance SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

JitPack

Integrate Trade Balance with No-Code API Tools

Connect the Trade Balance API to your favorite automation platform without writing code. Build workflows that leverage trade balance data across thousands of apps.

ZapierConnect Trade Balance to 6,000+ apps

MakeBuild visual trade balance workflows

PipedreamCode-friendly trade balance automation

n8nSelf-host your trade balance workflows

Power AutomateUse Trade Balance in Microsoft 365

Frequently Asked Questions

People who used this also used...

Based on your interest in Trade Balance, you might also like these APIs:

VAT Rates

VAT Rates provides current and historical Value Added Tax rates for EU and non-EU countries. Includes standard, reduced, and special rates with support for regional exceptions.

1 credit per call

Unemployment Rate

Unemployment Rate is a tool for retrieving unemployment statistics by country. It returns the unemployment rate as a percentage of the total labor force, with data available for over 200 countries from 1991 to present.

1 credit per call

Treasury Yields

Treasury Yields provides current and historical interest rates for US Treasury securities including T-bills, T-notes, T-bonds, TIPS, and Floating Rate Notes. Essential data for yield curve analysis and fixed income research.

1 credit per call