Check your API key

API TraderAPI QuantAPI DeveloperAPI Enterprise

Check an API key without spending anything. Send the key the way you send it to any other endpoint and the response says whether it works and what it carries: its plan, its rate limit, its remaining credits, when it expires, and which endpoints and regions it covers.

Every valid key may call this endpoint, whatever its plan, and it is never charged. It is throttled like every other call. A key that is missing, malformed or unknown gets a 401; one that has expired, been revoked or been disabled gets a 403 naming which.

Available Data Points:

  • Key Prefix: The public part of the key, before the dot. Quote it to support; never share the rest.
  • Tier: The API plan the key's limits come from.
  • Rate Limit: The rate the key is throttled at, for example 5/sec.
  • Credits Remaining: Credits left this cycle on a plan charged per call; null on Enterprise.
  • Expires At: When the key stops working, or null if it does not expire.
  • Enterprise: Whether the key may call the enterprise endpoints.
  • Region Restriction: The regions the key's data is limited to, or null when unrestricted.
  • View Groups: The endpoint groups the key may call.
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json