Trade Balance API

Overview

To use Trade Balance, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

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

Example

How to call the Trade Balance API in different programming languages.

curl -X GET \
  "https://api.apiverve.com/v1/tradebalance?date=2023-06" \
  -H "X-API-Key: your_api_key_here"

const response = await fetch('https://api.apiverve.com/v1/tradebalance?date=2023-06', {
  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?date=2023-06', headers=headers)

data = response.json()
print(data)

package main

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

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/tradebalance?date=2023-06", 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))
}

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

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. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?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

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all 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: "2023-06"
    }
  ) {
    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 accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Trade Balance requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Trade Balance API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Trade Balance

Official Trade Balance packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Trade Balance works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

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 US Treasury constant-maturity market yields across the full curve (1-month through 30-year), plus TIPS real yields. Essential data for yield curve analysis and fixed income research.

1 credit per call