Firmalar

Ticaret firmalarını (ithalatçı veya ihracatçı) arama ve sayma endpoint'leri.

Tüm istekler X-API-KEY ve X-SIGNATURE header'ları gerektirir. Bkz. Kimlik Doğrulama.

POST /api/v1/firms/search

Belirtilen filtre kriterlerine uyan firmaları arar. Sayfalı firma listesi döner.

Request Body

Alan	Tip	Zorunlu	Kısıtlar	Açıklama
page	integer	Evet	min: 1	Getirilecek sayfa numarası
account_name	string	Hayır	—	İstek için hesap bağlamı
importer_countries	array[string]	Hayır	max 10 öğe	İthalatçı ülkeye göre filtreleyen ISO ülke kodları. Belirtilmezse `["ALL"]`
exporter_countries	array[string]	Hayır	max 10 öğe	İhracatçı ülkeye göre filtreleyen ISO ülke kodları; en az bir başka parametre gerektirir
hs_codes	array[string]	Hayır	max 10 öğe; yalnızca rakam	Filtrelenecek HS kodları
start_date	string	Hayır	format: `yyyy-MM-dd`	Sevkiyat tarih aralığı başlangıcı
end_date	string	Hayır	format: `yyyy-MM-dd`	Sevkiyat tarih aralığı bitişi
firm_filter	array[integer]	Hayır	—	Firma tipi kodları
search_type	string	Hayır	`"importer"` veya `"exporter"`	Aranacak ticaret yönü
product_detail	string	Hayır	min 3 karakter	Ürün açıklaması anahtar kelimesi
exporter_firm	string	Hayır	min 3 karakter	İhracatçı firma adı anahtar kelimesi
importer_firm	string	Hayır	min 3 karakter	İthalatçı firma adı anahtar kelimesi
brand_name	string	Hayır	min 3 karakter	Marka adı anahtar kelimesi
arrival_port	string	Hayır	min 3 karakter	Varış limanı anahtar kelimesi
departure_port	string	Hayır	min 3 karakter	Çıkış limanı anahtar kelimesi

En az bir filtre parametresi zorunludur. exporter_countries en az bir ek parametre gerektirir. NOT-operatörü parametreleri, pozitif bir parametre olmadan kullanılamaz.

Response

Alan	Tip	Açıklama
total_shipment	integer	Sorguya uyan toplam sevkiyat kaydı
total_pages	integer	Toplam sayfa sayısı
page	integer	Mevcut sayfa numarası
firms_count	integer	Bu sayfada dönen firma sayısı
firms	array[Firm]	Firma kayıtları listesi

Örnek

JavaScriptcURLJavaPython

import crypto from 'crypto'

const payload = JSON.stringify({
  page: 1,
  search_type: 'importer',
  importer_countries: ['US', 'DE'],
  hs_codes: ['847130'],
  start_date: '2024-01-01',
  end_date: '2024-12-31'
})

const signature = crypto
  .createHmac('sha256', 'api-secretiniz')
  .update(payload)
  .digest('base64')

const res = await fetch('https://apiv2.tradeatlas.com/api/v1/firms/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': 'api-keyiniz',
    'X-SIGNATURE': signature
  },
  body: payload
})
const data = await res.json()

bash

PAYLOAD='{"page":1,"search_type":"importer","importer_countries":["US","DE"],"hs_codes":["847130"],"start_date":"2024-01-01","end_date":"2024-12-31"}'

SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "api-secretiniz" -binary | base64)

curl -X POST https://apiv2.tradeatlas.com/api/v1/firms/search \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: api-keyiniz" \
  -H "X-SIGNATURE: $SIGNATURE" \
  -d "$PAYLOAD"

java

String payload = "{\"page\":1,\"search_type\":\"importer\",\"importer_countries\":[\"US\",\"DE\"],\"hs_codes\":[\"847130\"],\"start_date\":\"2024-01-01\",\"end_date\":\"2024-12-31\"}";

Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec("api-secretiniz".getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
String signature = Base64.getEncoder()
    .encodeToString(mac.doFinal(payload.getBytes(StandardCharsets.UTF_8)));

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://apiv2.tradeatlas.com/api/v1/firms/search"))
    .header("Content-Type", "application/json")
    .header("X-API-KEY", "api-keyiniz")
    .header("X-SIGNATURE", signature)
    .POST(HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

python

import hmac, hashlib, base64, requests

payload = '{"page":1,"search_type":"importer","importer_countries":["US","DE"],"hs_codes":["847130"],"start_date":"2024-01-01","end_date":"2024-12-31"}'

signature = base64.b64encode(
    hmac.new("api-secretiniz".encode(), payload.encode(), hashlib.sha256).digest()
).decode()

response = requests.post(
    "https://apiv2.tradeatlas.com/api/v1/firms/search",
    headers={
        "Content-Type": "application/json",
        "X-API-KEY": "api-keyiniz",
        "X-SIGNATURE": signature,
    },
    data=payload,
)
data = response.json()

Yanıt

json

{
  "total_shipment": 15420,
  "total_pages": 31,
  "page": 1,
  "firms_count": 500,
  "firms": [
    {
      "country": "United States",
      "country_code": "US",
      "name": "Tech Imports LLC",
      "address": "123 Commerce St, New York, NY 10001",
      "city_state": "New York, NY",
      "tel": "+1 212 555 0100",
      "e_mail": "[email protected]",
      "web": "www.techimports.example.com",
      "firm_type": 1,
      "shipment_count": 42
    }
  ]
}

POST /api/v1/firms/count

Belirtilen filtre kriterlerine uyan firmaları sayar.