Appearance
Overview
Trade intelligence API providing access to firm and shipment data with search and analytics capabilities.
Base URL
All requests are made against the following base URL:
https://apiv2.tradeatlas.com| Base URL | https://apiv2.tradeatlas.com |
| Content-Type | application/json |
| API Version | v1 |
Workflow
- Authentication — Obtain your API key and API secret from the TradeAtlas portal; send the
X-API-KEYheader and a per-requestX-SIGNATUREheader. - Send queries to the Firms or Shipments endpoints.
- Process the returned Models, using the Country Codes reference where needed.
Pagination
Search endpoints return paginated results:
- Firm search uses the
pagefield to select the page number. - Shipment search uses the
sizefield to control how many records are returned.
Contents
| Section | Description |
|---|---|
| Authentication | API key, secret, and signature generation |
| Firms | Firm search and count endpoints |
| Shipments | Shipment search and count endpoints |
| Usage Statistics | Your account's API usage and limits |
| Models | Response data models and enum values |
| Country Codes | ISO 3166-1 alpha-2 country codes |
| Errors | HTTP status codes and business error codes |
