Skip to content

Kullanım İstatistikleri

Hesabınızın API kullanımını ve limitlerini sorgulama endpoint'i.

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


GET /api/v1/statistics/usage

Kimliği doğrulanan çağıranın kendi hesaplarına ait kullanım ve limit özetini döner. İstek gövdesi (body) veya parametre almaz.

İMZA (GET)

Bu bir GET isteğidir; gövdesi yoktur. X-SIGNATURE, boş string "" üzerinden hesaplanır. Bkz. Kimlik Doğrulama.

Response

Yanıt, { hesap adı → { metrik → özet } } biçiminde iç içe bir nesnedir. Her metrik aşağıdaki alanları içerir:

AlanTipAçıklama
currentintegerBu metrik için şu ana kadar kullanılan miktar
limitintegerİzin verilen üst limit. -1 sınırsız anlamına gelir
notesstringOpsiyonel. Limit sınırsızsa "unlimited"; searchedHsCodes için aranan HS kod listesi

Metrikler

MetrikAnlamı
firms/searchFirma arama (indirme) kullanımı
firms/countFirma sayma kullanımı
shipments/searchSevkiyat arama (indirme) kullanımı
shipments/countSevkiyat sayma kullanımı
searchedHsCodesAranan farklı HS kodu sayısı
dailyRequestGünlük istek sayısı
minutelyRequestDakikalık istek sayısı

Örnek

js
import crypto from 'crypto'

const payload = '' // GET isteğinin gövdesi yoktur

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

const res = await fetch('https://apiv2.tradeatlas.com/api/v1/statistics/usage', {
  method: 'GET',
  headers: {
    'X-API-KEY': 'api-keyiniz',
    'X-SIGNATURE': signature
  }
})
const data = await res.json()
bash
SIGNATURE=$(printf '' | openssl dgst -sha256 -hmac "api-secretiniz" -binary | base64)

curl -X GET https://apiv2.tradeatlas.com/api/v1/statistics/usage \
  -H "X-API-KEY: api-keyiniz" \
  -H "X-SIGNATURE: $SIGNATURE"
java
String payload = ""; // GET isteğinin gövdesi yoktur

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/statistics/usage"))
    .header("X-API-KEY", "api-keyiniz")
    .header("X-SIGNATURE", signature)
    .GET()
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
python
import hmac, hashlib, base64, requests

payload = ""  # GET isteğinin gövdesi yoktur

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

response = requests.get(
    "https://apiv2.tradeatlas.com/api/v1/statistics/usage",
    headers={
        "X-API-KEY": "api-keyiniz",
        "X-SIGNATURE": signature,
    },
)
data = response.json()

Yanıt

json
{
  "My Account": {
    "firms/search":     { "current": 1240, "limit": 5000 },
    "firms/count":      { "current": 87,   "limit": 1000 },
    "shipments/search": { "current": 1240, "limit": 5000 },
    "shipments/count":  { "current": 87,   "limit": 1000 },
    "searchedHsCodes":  { "current": 3,    "limit": 50, "notes": "[847130, 850760, 852990]" },
    "dailyRequest":     { "current": 320,  "limit": 10000 },
    "minutelyRequest":  { "current": 5,    "limit": 120 }
  }
}

Sınırsız bir limit -1 olarak döner ve ilgili metrikte "notes": "unlimited" yer alır.

Nexus Backend API Dokümantasyonu