Start trial

API reference

Account

Credits used and remaining for your organisation, broken down by endpoint and key.

Credits used and remaining

GET /v1/usage

Free Operation ID account.usage

Usage of the calling key's organisation over a UTC window, by key and endpoint. Defaults to the current billing period. Figures can trail live traffic by a few seconds.

Query parameters

  • from timestamp

    Start of the window, rounded down to the hour

  • to timestamp

    End of the window, rounded up to the hour

Response

  • data object
    Show 6 fields
    • creditsRemaining integer or null

      Credits left under the tightest limit right now, null when unlimited

    • creditsUsed integer
    • from timestamp
    • keyId string

      The key making this call

    • lines array of objects
      Show 4 fields
      • credits integer
      • keyId string
      • operationId string
      • requests integer
    • to timestamp
  • meta object
    Show 3 fields
    • asOf timestamp or null

      The point in time this data describes, like when a filing was published. Null where that doesn't apply, as with account data

    • credits integer

      Credits this call cost

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.