API Status Codes

While most of the status codes below may be returned after a request has started processing, the following status codes are returned immediately: 400, 401, 403, 429.

A similar request cannot be run more than once concurrently. For example we cannot have two requests for Mcdonald's running at the same time. When this occurs, all similar requests will be failed and a 403 status code will be returned.

200 OK

The request has succeeded. Only used by the /update/status endpoint.

{
    "request_id": "1666370028588267100-dcf4609d-e966-40",
    "created_at": "2022-10-21T12:33:48",
    "completeness_rate": 1.0,
    "success_rate": 1.0,
    "status": "COMPLETE",
    "size": 0
}

201 CREATED

The request was accepted, job has been enqueued for processing.

{
    "success": true,
    "message": "Your task was successfully submitted.",
    "request_id": "1647761879090578224-98f69326-71a4-4e"
}

400 BAD REQUEST

Invalid request. Check your parameters.

{
    "success": false,
    "message": "Bad request.",
    "request_id": "1647761809872655750-edfda5ef-c39b-4b",
    "details": "Missing parameter. The following must be present: callback. Please make sure to provide this parameter and make the request again."
}

401 UNAUTHORIZED

Missing or invalid API key.

{
    "success": false,
    "message": "User unauthorized.",
    "request_id": "1647762006517428506-2403ffa-e810-40",
    "details": "Please make sure your API key is valid and then retry the request."
}

403 FORBIDDEN

Credits exhausted or similar request already processing.

{
    "success": false,
    "message": "Credit Exhausted",
    "request_id": "1666370028588267100-2403ffa-c39b-40",
    "details": "You seem to be out of credits. Kindly contact support to get more credits"
}

{
    "success": false,
    "message": "A request for the same company is already in progress",
    "request_id": "1647762006517428506-2403ffa-e810-40",
    "details": "A request for the same company is already in progress"
}

429 TOO MANY REQUESTS

Rate limit violation.

    "success": false,
    "message": "Too many requests.",
    "request_id": "1647762006517428506-2403ffa-e810-40",
    "details": "You've reached your requests limit at the moment."

500 INTERNAL SERVER ERROR

Internal error.

    "success": false,
    "message": "Internal server error.",
    "request_id": "1647762006517428506-2403ffa-e810-40",
    "details": "Sorry, we were not able to process your request. Please try again. If the issue persists, please get in touch with us at support@datashake.com."

520 APP FAILED

Application failed.

    "success": false,
    "message": "Application failed.",
    "request_id": "1647762006517428506-2403ffa-e810-40",
    "details": "Sorry, we were not able to process your request. Please try again. If the issue persists, please get in touch with us at support@datashake.com.",

521 NO RESULTS

No search results found.

    "success": false,
    "message": "No results."
    "request_id": "1647762006517428506-2403ffa-e810-40",
    "details": "Sorry, we were not able to find any results for your search. Try to modify the request by adding more information about the company and make sure we support the company requested. If the issue persists, please get in touch with us at support@datashake.com."