ArzDigital API
فارسیSign inSign up
ArzDigital API

Your key

Get the calling key's plan, balance and limits

GEThttps://api.arzdigital.com/v1/key/info
X-API-Key headerHow credits work

Free. It still works at zero balance and after a plan expires, so you can always find out why calls are being refused. It counts toward the per-minute rate limit.

Credit use: This call is free.

An empty result and any error cost nothing.

Parameters

This call takes no parameters.

Request headers

  • X-API-KeystringRequired

    Your API key. Send it in this header on every call; it is not accepted in the URL.

Response

The key, plan, balance and limits. X-Credits-Charged is 0.
Response fields (20)
  • statusstring
  • dataobject
  • data.keyobject
  • data.key.prefixstring
    The visible 8-character key prefix.
  • data.key.namestring | null
  • data.key.statusstring
  • data.planobject
  • data.plan.codestring
  • data.plan.namestring
  • data.creditsobject
  • data.credits.balanceinteger
    Current balance. Can be negative.
  • data.credits.allowanceinteger
    Credits granted per period.
  • data.credits.reset_atstring
    When the balance next resets.
  • data.limitsobject
  • data.limits.requests_per_minuteinteger
  • data.limits.history_depth_daysinteger | null
    Days of history the plan allows. Null means full history.
  • data.limits.max_keysinteger
  • data.subscriptionobject
  • data.subscription.statusstring
  • data.subscription.ends_atstring | null
    Null when the plan does not expire.

Response headers

  • X-Credits-Charged
    Credits this call cost. 0 on every non-200 response.
  • X-Credits-Remaining
    Account balance after this call, not counting what calls still in flight have set aside. Negative only for an account in debt after an adjustment.
  • X-RateLimit-Limit
    Requests per minute allowed for this key.
  • X-RateLimit-Remaining
    Requests left in the current window.
  • X-RateLimit-Reset
    Unix seconds at which the window has room again.

Errors

  • invalid_keyerror_code 1002
    The key is missing

Errors are never charged. Errors