Errors will return with standard HTTP status codes.

Status codes are as follows:

  • 1xx: Informational - Communicates transfer protocol-level information.
  • 2xx: Success - The request was successful.
  • 3xx: Redirection - The client must take some additional action to complete the request.
  • 4xx: Client Error - Failed request due to client error.
  • 5xx: Server Error - Failed request due to server error.

200 Success

A successful request was made.

400 Bad Request

A 400 Bad Request error means that the server was unable to proceed with the request. The most common cause of the error is bad syntax in the request URL or body.

401 Unauthorized

401 Unauthorized errors are usually caused by a problem in the request header of your API call, i.e. you didn’t use a valid API key to make the API call.

403 Access Denied

When your application makes an API call with your API key and the request is not allowed.

404 Resource Not Found

This error occurs when your application tries to call an API or fetch an entity that does not exist.

405 Method Not Allowed

This error indicates that the HTTP protocol methods in your request are not supported. Check the documentation for the API to see supported methods.

429 Rate Limit

Rate Limit: 250 API requests every 5 minutes per User Profile.

  • In the response header:

    • x-ratelimit-max: Indicates the highest number of requests allowed for the User Profile within a specific time frame.
    • x-ratelimit-count: Shows the number of requests made for the User Profile during the current 5-minute interval.
  • Analytics for X/Twitter has a rate limit of 500 API requests every 24 hours per Business User Profile and 300 API requests every 24 hours per Premium account. If you require an enhanced Twitter package, please contact your account representative.
  • X/Twitter requests are limited to 50,000 per month for Business Plan accounts and 2,000 per month for Premium Plan accounts. The limit is reset on the 2nd of the month at 00:00 UTC. If you require an enhanced Twitter package, please contact your account representative.
  • If a User Profile exceeds the rate limit more than 1,000 times in a 24-hour period, it will be automatically suspended to safeguard our system. It is crucial to handle 429 (rate limit exceeded) responses effectively. For instance, should you execute 200 requests for a specific User Profile within a minute, you must wait an additional four minutes before making further requests for that Profile. Any attempts to make more requests during this five-minute interval will result in a 429 error. Should you accumulate 1,000 such errors within a day, the User Profile will be suspended. Once the five-minute waiting period concludes, you’re allowed to make another 250 requests for the same User Profile.

500 Internal Server Error

A 500 Internal Server Error indicates that Ayrshare is experiencing an internal error or processing failed.