Status

Public service status

A single unauthenticated endpoint. Use it to check that the API is reachable, to discover the documentation and the OpenAPI description, and to read the rate limit headers before you start making authenticated calls.

show

GET /api/v1/status

Service status

Returns the status of the API. No authentication required.

Every response from this API, including this one, carries RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset and RateLimit-Policy. Exceeding the limit returns 429 with Retry-After in seconds.

Returns

Code: 200

The service status

Name	Type	Required	Description
`status`	Must be a String	Required	‘ok’ while the API is serving requests
`api_version`	Must be a String	Required	Current API version
`documentation_url`	Must be a String	Required	Human readable API reference
`openapi_url`	Must be a String	Required	OpenAPI description of this API
`developer_portal_url`	Must be a String	Required	Developer portal: quickstart, auth, webhooks
`authentication`	Must be a String	Required	How to authenticate a request
`rate_limit`	Must be a Hash	Required	The rate limit in force
`rate_limit[limit]`	Must be a Integer	Required	Requests allowed per window
`rate_limit[window_seconds]`	Must be a Integer	Required	Length of the window in seconds
`rate_limit[scope]`	Must be a String	Required	What the limit is counted against
`versioning`	Must be a Hash	Required	Which versions are served, and how retirement is signalled
`versioning[current]`	Must be a String	Required	The version to build against
`versioning[supported]`	Must be an array of any type	Required	Every version still serving requests
`versioning[deprecated]`	Must be an array of any type	Required	Versions that are deprecated but still serving
`versioning[policy_url]`	Must be a String	Required	The published versioning and deprecation policy
`versioning[signalling]`	Must be a String	Required	The headers a deprecated version sends