COcoinpaprika
Key

Get API key info

Returns API key information:

  • Name of the API key plan
  • When the plan started
  • A flag indicating if the plan is active
  • Link to the API user portal
  • Monthly usage

Available on the following API plans:

  • Starter
  • Pro
  • Business
  • Ultimate
  • Enterprise

Update interval: Every 1 minute.

get/key/info

Request

Response

successful operation

planstring

Name of the API plan

plan_started_atstring

A date when the plan started in RFC3999 (ISO-8601) format

plan_statusstring

Status of the plan. There are 3 possible statuses: active - the subscription is active; past_due - the subscription payment failed. If payment is not made within 7 days, then the subscription will expire; inactive - the subscription is inactive.

portal_urlstring

API Customer Portal URL

Example response

{
  "plan": "pro",
  "plan_started_at": "2022-09-16T10:17:24Z",
  "plan_status": "active",
  "portal_url": "https://coinpaprika.com/api-panel",
  "usage": {
    "message": "limited plan",
    "current_month": {
      "requests_made": 18,
      "requests_left": 499982
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.