You can access the REST API docs from the sidebar or download the cde-public-api-spec.json openAPI spec directly.

​
Basics

All requests and responses are application/json content type and follow typical HTTP response status codes for success and failure. Request URLs must be lowercase as URLs are case-sensitive.

​
Status Codes

​
Success

A successful response is indicated by HTTP status code 200 and may contain an optional body. If the response has a body it is documented under each resource.

​
Errors

{
    "message": "Invalid symbol"
}
Unless otherwise stated, errors to bad requests respond with HTTP 4xx or status codes. The body also contains a message parameter indicating the cause. Your language HTTP library should be configured to provide message bodies for non-2xx requests so that you can read the message field from the body.

​
Common Error Codes

Status CodeReason
400Bad Request — Invalid request format
401Unauthorized — Invalid API Key
403Forbidden — You do not have access to the requested resource
404Not Found
500Internal Server Error