All error responses contain an appropriate HTTP status code and have the following format:
{
"errorCode": "InvalidRequestParameters",
"message": "Bad request. Please review errors.",
"errors": [
{
"errorCode": "InvalidExchange",
"fieldName": "Exchange",
"fieldValue": null,
"message": "Exchange cannot be empty."
}
]
}
HTTP status code | Error code | Notes |
---|---|---|
400 | RequestMissing | The entire request is missing and needs to be set by the client. |
400 | InvalidRequestParameters | The request contains invalid parameters. The errors with the invalid parameters will be in the errors array (see parameters level errors reference below for more details). |
403 | AccessDenied | Your client doesn't have access to this endpoint, try calling the "DELETE /sessions/application/v1" endpoint and try again, if still not working please contact support. |
404 | EndpointNotFound | The endpoint called does not exist. |
429 | ApiCallsFrequencyExceeded | The number of requests made to the API exceeds the maximum allowed for the period of time (eg: 30 calls per second). |
429 | ActiveApiCallsExceeded | The number of active requests made to the API exceeds the maximum allowed. Active requests are requests that haven't returned yet and are still processing. Those also include subscriptions to updates. |
429 | MaxUpdatesQueuedExceeded | Too many updates were queued since the last call. Call the update endpoint more often and or break down the request in ones returning less updates. |
500 | InternalServerError | An unhandled error occured in the API. If it still happens after retrying please contact support with the request made. |
503 | ServiceUnavailable | A temporary error occured in the API. If it still happens after retrying please contact support with the request made. |
Error code | Notes |
---|---|
InvalidExchange | The Exchange parameter passed in the request is invalid. See message for more details. |
InvalidDateFrom | The DateFrom parameter passed in the request is invalid. See message for more details. |
InvalidDateTo | The DateTo parameter passed in the request is invalid. See message for more details. |
InvalidDateTimeFrom | The DateTimeFrom parameter passed in the request is invalid. See message for more details. |
InvalidDateTimeTo | The DateTimeTo parameter passed in the request is invalid. See message for more details. |
InvalidConsolidationInterval | The ConsolidationInterval parameter passed in the request is invalid. See message for more details. |
InvalidSecurity | The Security parameter passed in the request is invalid. See message for more details. |
InvalidSecurities | The Securities parameter passed in the request is invalid. See message for more details. |
InvalidDataTypes | The DataTypes parameter passed in the request is invalid. See message for more details. |
InvalidDataType | The DataType parameter passed in the request is invalid. See message for more details. |
InvalidRequestIds | The RequestIds parameter passed in the request is invalid. See message for more details. |
RequestAlreadyProcessed | The RequestId used in the X-Request-ID header has already been processed by another request. |
RequestAlreadyInUse | The RequestId used in the X-Request-ID header is already being used for a different updates subscription. |
RequestNotFound | The RequestId used in the X-Request-ID header to retrieve updates could not be found. You will need to restart the updates subscription flow. |
InvalidSystemListName | The SystemListName parameter passed in the request is invalid. See message for more details. |
InvalidUpdates | The Updates header parameter passed in the request is invalid. See message for more details. |
InvalidMarkets | The Markets parameter passed in the request is invalid. See message for more details. |
InvalidMarket | The Market parameter passed in the request is invalid. See message for more details. |
InvalidAskLevelMax | The AskLevelMax parameter passed in the request is invalid. See message for more details. |
InvalidBidLevelMax | The BidLevelMax parameter passed in the request is invalid. See message for more details. |