Chainnodes RPC Error Codes Explained

In the context of this document we define the following phrases:

• OFTEN -> we are emitting this error often, most likely due to a client mistake of using our APIs wrongly
• SOMETIMES -> can happen because of client or server errors, but still mostly due to mistakenly using our APIs the way they are not supposed to be used
• RARELY -> happens nearly never because usage is obvious enough and only malicious actors would make this wrong
• VERY RARELY -> server only errors which happen extremely rarely and shouldn't be expected in normal day to day activities

All of that can vary depending on your usage. If you obey rules and know the APIs, most of the errors won't ever happen. The percentages are averages on Chainnodes based on what we know.

Depending on your plan, you might have a 99.9% SLA guarantee. Error codes that are expected errors, as defined in the table below, do not count towards downtime.

As our API is based on the JSON-RPC spec (opens in a new tab), the error codes and messages received from our servers will always be formatted in the following format:

{
    "jsonrpc": "2.0",
    "error": {
        "message": "invalid api key",
        "code": 401
    },
    "id": 1
}

Alternatively, we sometimes use the optional error.data object to provide additional details. Do not depend on this value in your code, but rather use it to debug manually if you receive unexpected errors. Also provide it if you request support in our public channels our via email. ☝️

Below is a list of error codes and messages Chainnodes API typically respond with and what they mean.

• Error Code is the JSON-RPC Error Code returned
• HTTP Status is the status code we return, which only applies to HTTP calls (not Websocket).
• 'Client' means you can fix it by fixing your request. / 'Server' means it's an issue out of your direct control.