Skip to content
TrackPin developers

API reference

Usage

GET/v1/usage

Your plan and today's usage. Calls to it don't count against your quota.

Not meteredTry it

Response

A JSON object. reset is an ISO 8601 time in UTC.

  • planone offreeprobusiness

    Your plan.

  • labelstring

    Plan name.

  • usedinteger

    Requests counted today (UTC).

  • limitinteger

    Daily quota.

  • remaininginteger

    Requests left today.

  • resetstring

    ISO time of the next reset (00:00 UTC).

  • key_prefixstring

    The first characters of your key, for identification.

Notes

  • Calls to /v1/usage never count against your quota.
  • They don't count toward your plan's per-minute ceiling either, but have one of their own: 60 a minute per key.
  • Through RapidAPI, your usage and quota are in your RapidAPI dashboard: this endpoint answers only channel (rapidapi) and a message saying so.

Errors

  • 401missing api key

    No key sent.

  • 401invalid api key

    Unknown or revoked key.

  • 405method not allowed

    The data endpoints are GET only. The Allow header lists the methods an endpoint answers: GET, HEAD and OPTIONS (POST and OPTIONS for /v1/keys/rotate).

  • 429rate limit exceeded

    More than 60 calls a minute to /v1/usage; wait Retry-After seconds. The body adds limit, window_s and retry_after_s.

  • 500internal error

    Something failed on our side, not in your request.

  • 503temporarily unavailable

    Our database can't be reached right now. Retry after the number of seconds in the Retry-After header.

Error bodies are {"error": string}. See Errors and Quotas.

Try it

Send a real request from this page with your key. It goes from your browser straight to TrackPin.

Stays in this tab's session storage until you close the tab. Never added to a URL.

Request

GET /api/v1/usage

x-api-key: pk_…

Checking usage doesn't count against your quota.

Response

Send a request to see the status, headers and body here.

Early access.

Free keys are emailed straight away; Pro and Business are bought by card through Stripe. Request an API key