Skip to content

API Overview

RegionBase URL
UShttps://api.traceclick.io
EUhttps://api-eu.traceclick.io

Use the base URL that matches the region your app was created in.

All API endpoints require an API key passed in the X-Api-Key header:

Terminal window
curl https://api.traceclick.io/v1/links \
-H "X-Api-Key: tr_live_xxxxxxxxxxxx"

API keys start with tr_live_ for production or tr_test_ for sandbox environments.

EndpointLimitScoped by
POST /v1/links60 req/minAPI key
GET /v1/links120 req/minAPI key
PATCH /v1/links/{code}60 req/minAPI key
DELETE /v1/links/{code}60 req/minAPI key
POST /v1/privacy/*30 req/minAPI key
POST /v1/debug/attribution30 req/minIP address

When you exceed a rate limit, the API returns 429 Too Many Requests. Wait and retry after a short delay.

The API returns standard HTTP status codes with a JSON error body:

{
"error": "Short description of the problem"
}
StatusMeaning
400Bad request — invalid JSON, missing required field, or validation failure
401Unauthorized — missing or invalid API key, or region mismatch
404Not found — the requested resource doesn’t exist
429Rate limit exceeded — too many requests, retry later
500Server error — something went wrong on our end

All request and response bodies use JSON. Set the Content-Type header for POST/PATCH requests:

Terminal window
curl -X POST https://api.traceclick.io/v1/links \
-H "X-Api-Key: tr_live_xxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"deepLinkPath": "/welcome"}'