Usage and limits
The counters and limits of your account for the current UTC month, per product: calls made, unique references used, what is left, and overage. Send key_ids or key_status to add the figures of selected API keys under data.key_usage.
Not counted: reading your own usage is an account path and spends no call quota. See what counts as a successful request.
Query parameters
Comma-separated ids of your own API keys. Adds data.key_usage with the figures of those keys.
Comma-separated key categories: active, expired, revoked. Combines with key_ids. A selection that matches no key answers zeros.
Response schema
145 fields
Generated from the OpenAPI spec. Nested exactly as the JSON is. Open a branch to read its fields; hover a name for the full dot-path.
Whether the request succeeded.
data
The payload. Everything an endpoint returns sits under this key.
UTC calendar month these counters cover.
Earliest valid_until across enabled products; access ends after this date.
Requests refused because YOUR reference was malformed or its carrier is unsupported.
products[]
Requests we turned away this month (over the unique allowance, expired access, or a per-key rate cap).
calls
API-call traffic against your plan's call allowance.
Calls allowed this period (your plan allowance, lowered by any per-key rate cap).
Of used, the calls made on a test key.
allowance
What you can consume, in the unit you are billed: one unique reference per period.
Maximum unique references this period; null means no ceiling is set.
Unique references charged this period.
The month these figures cover, YYYY-MM.
overage
What happens when the allowance runs out.
Whether overage terms have been agreed for this account.
Whether you switched overage on.
How far past the limit service continues, as a percentage of the limit.
Price per unit of overage.
Currency of unit_price, EUR by default.
The number that actually refuses: limit plus grace when armed, else the limit.
Units consumed beyond the limit.
Estimated overage charge so far.
What happens at the limit.
forecast
Straight line projection of this month.
Average units consumed per elapsed day.
Where the month ends at the current rate.
Calendar days left in the month, including the rest of today.
Days until the limit is reached at the current rate, null when it is not reached.
True when the projection passes the limit before the month ends.
key_usage
Present only when key_ids or key_status was sent.
selection
keys[]
products[]
One of: container, aircargo, schedules, freightrates.
Null for a calls-only product.
Existing record id. Only on status 400, 401, 403, 404, 429, 500 and 504.
When tracking stopped. Only on status 400, 401, 403, 404, 429, 500 and 504.
Null when your account archived it, otherwise the reason our archiver closed it. Only on status 400, 401, 403, 404, 429, 500 and 504.
resume
Only on status 400, 401, 403, 404, 429, 500 and 504.
body
The reference to add again.
The response contract this build answers, as a date (YYYY-MM-DD).
error
Only on status 400, 401, 403, 404, 429, 500 and 504.
Machine readable error code.
Human readable explanation.
How serious the error is.
True.
The reference.
Seconds to wait.
Offending fields.
CONTAINER_QUOTA_EXCEEDED only.
Tokens this request needs.
Tokens the wallet holds.
Where to top up.
Plans on offer.
packages[]
Plan key.
Tokens per month.
Monthly price in USD.
CARRIER_NOT_IDENTIFIED only.
CARRIER_NOT_IDENTIFIED, timed out only.
The member cycle limit.
Tokens the member has used this cycle.
Tokens left for the member.
Seconds until the next refresh is allowed.
progress
One of: SEALINE_HASNT_PROVIDE_INFO, NO_EVENTS, WRONG_NUMBER, REFERENCE_REQUIRED, LINE_NOT_SUPPORTED, PENDING, UNRESOLVED.
previous_trip
The trip before yours for this box, when the line still reports it.
The line that answered, as its SCAC.
last_event
events[]
A note for leasing-company accounts when no line holds the box yet.
One of: in_progress, not_supported, connected, reference_required.
carrier_notice
Latest reference-specific reply from the named carrier. Only on status 400, 401, 403, 404, 429, 500 and 504.
One of: other_carrier, temporarily_unavailable, not_found, invalid_reference, SHIPMENT_CANCELLED, no_longer_available.
Present when the line named was not used. Only on status 400, 401, 403, 404, 429, 500 and 504.
Known line that cannot be asked. Only on status 400, 401, 403, 404, 429, 500 and 504.
upgrade
CONTAINER_QUOTA_EXCEEDED only. Only on status 400, 401, 403, 404, 429, 500 and 504.
Next plan.
Monthly price.
Annual price.
Why the line named was not used. Only on status 400, 401, 403, 404, 429, 500 and 504.
Errors
A failure carries { "ok": false, "error": { "code", "message", "severity" } }. Branch on the code, and log the message.
key_status is not active, expired or revoked, or key_ids carries a value that is not a key id.
The key is missing, malformed or revoked.
A key id in key_ids is not a key of your account.
We could not read the counters. Retry.
curl 'https://api.navo24.com/v1/tracking/usage' \
-H "Authorization: Bearer tmcp_YOUR_API_KEY"const res = await fetch("https://api.navo24.com/v1/tracking/usage", {
headers: {
"Authorization": "Bearer tmcp_YOUR_API_KEY"
}
});
const data = await res.json();import requests
res = requests.get(
"https://api.navo24.com/v1/tracking/usage",
headers={"Authorization": "Bearer tmcp_YOUR_API_KEY"},
)
data = res.json(){
"api_version": "2026-08-04",
"ok": true,
"data": {
"period": "2026-11",
"products": [
{
"product": "container",
"channel": "api",
"plan": "paid",
"billing_mode": "monthly",
"period": "2026-11",
"calls": { "used": 310, "test_used": 0, "limit": 5000, "remaining": 4690 },
"allowance": { "basis": "unique_reference", "limit": 100, "used": 42, "remaining": 58 },
"overage": {
"available": true,
"enabled": true,
"pct": 20,
"unit_price": 0.5,
"currency": "EUR",
"ceiling": 120,
"used": 0,
"estimated_cost": 0,
"at_limit": "bills_overage"
},
"forecast": { "run_rate_per_day": 4.2, "projected": 126, "days_left": 20, "days_to_cap": 13, "will_exhaust": true },
"valid_until": "2026-12-20",
"start_date": "2026-09-01",
"refused_this_month": 0,
"last_refused_at": null
}
],
"invalid_references_this_month": 0,
"next_expiry": "2026-12-20"
}
}