Errors

To ensure a smooth experience with the Mashvisor API and to expedite any necessary troubleshooting, we kindly ask that you observe the following guidelines regarding technical support.

Pre-Support Checklist

Our internal diagnostics indicate that the vast majority of API disruptions are related to integration specifics rather than server-side outages. To help us provide the most efficient service, please verify the following before opening a support ticket:

  • Syntax & Parameters: Ensure all required fields are included and that data types match the documentation specifications.
  • Authentication: Confirm your API keys are active and properly included in the request headers.
  • Rate Limits: Review your current plan limits to ensure your application is not exceeding the allocated request frequency.
  • Response Codes: Check for standard HTTP error codes (e.g., 400, 401, or 422) which often point to specific client-side adjustments needed.

Optimizing Your Support Experience

If an issue persists after a thorough code review, please contact our support team with your request payload, the endpoint used, and the error response received. This allows our engineers to pinpoint the root cause immediately and provide a swift resolution.


Status codes

Here is a list of the different categories of status codes returned by the Mashvisor API. Use these to understand if a request was successful.

  • Name
    2xx
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Description

    A 4xx status code indicates a client error — this means it's input error problem.

  • Name
    5xx
    Description

    A 5xx status code indicates a server error — please contact support if you're seeing this


Error types

Whenever a request is unsuccessful, the Mashvisor API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of error types supported by the Mashvisor API — use these to understand what you have done wrong.

  • Name
    400
    Description

    Bad Request -- Your request is invalid.

  • Name
    401
    Description

    Unauthorized -- Your API key is wrong.

  • Name
    404
    Description

    Not Found -- The specified property could not be found.

  • Name
    429
    Description

    Too Many Requests -- You're sending too many requests! Slow down!

  • Name
    500
    Description

    Internal Server Error -- We had a problem with our server. Try again later.

  • Name
    503
    Description

    Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Error response

  {
      "status": "error",
      "code": 401,
      "message": "Invalid api access Key"
  }

Was this page helpful?