Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong with the inputs and do some rudimentary debuggingl


Status codes

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

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — this means the input was not expected. You will see this a lot if for instance the requested $SELF name was not registered.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — you won't be seeing these.


Error types

Whenever a request is unsuccessful, the SELF 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 the two error types supported by the SELF API — use these to understand what wente wrong.

  • Name
    api_error
    Type
    Description

    This means that the api can not resolve the input and results into an error reject.

  • Name
    invalid_request
    Type
    Description

    This means that the input can not be processed by the API logic.

Error response

{ "url" : "https://self-api.com/api/v1/evm/cause_a_404_error_please",
  "type": "api_error",
  "error_code": "403",
  "error_message": "No existing $Self name: cause_a_404_error_please "
}