News Api Errors

Error Format

All error responses contain an appropriate HTTP status code and have the following format:

{
    "errorCode": "InvalidRequestParameters",
    "message": "Bad request. Please review errors.",
    "errors": [
        {
            "errorCode": "InvalidHeadlineId",
            "fieldName": "Exchange",
            "fieldValue": null,
            "message": "HeadlineId: 'abc' in HeadlineIds is invalid."
        }
    ]
}

  • errorCode: Top level errorCode. This unique code identifies the type of top level error it is.
  • message: Human readable message describing the error.
  • errors: An array of errors specific to invalid request parameters passed by the client. Note, this might be null.
  • error.errorCode: Parameter level errorCode. This unique code identifies the type of parameter error it is.
  • error.fieldName: The name of the field in the request.
  • error.fieldValue: The value passed in the field by the client.
  • error.message: Human readable message describing the error.

Top level errors

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.

Parameter level errors

Error codeNotes
InvalidDateTimeFromThe InvalidDateTimeFrom parameter passed in the request is invalid. See message for more details.
InvalidDateTimeToThe InvalidDateTimeTo parameter passed in the request is invalid. See message for more details.
InvalidHeadlineIdsThe InvalidHeadlineIds parameter passed in the request is invalid. See message for more details.
InvalidHeadlineIdThe InvalidHeadlineId parameter passed in the request is invalid. See message for more details.
InvalidCategoryIdThe InvalidCategoryId parameter passed in the request is invalid. See message for more details.
InvalidSecurityThe InvalidSecurity parameter passed in the request is invalid. See message for more details.
InvalidVendorCodesThe InvalidVendorCodes parameter passed in the request is invalid. See message for more details.
InvalidVendorCodeThe InvalidVendorCode parameter passed in the request is invalid. See message for more details.
InvalidTextThe InvalidText parameter passed in the request is invalid. See message for more details.
InvalidRequestIdsThe RequestIds parameter passed in the request is invalid. See message for more details.
RequestAlreadyProcessedThe RequestId used in the X-Request-ID header has already been processed by another request.
RequestAlreadyInUseThe RequestId used in the X-Request-ID header is already being used for a different updates subscription.