Errors

Errors are a part of life. The guide below will help you understand the various codes Yuzu will return and recovery patterns.

Error responses in GraphQL will not present like errors from traditional APIs. All responses from GraphQL APIs, execept network errors (e.g., 503 Bad Gateway), will return a 200 status code. In an error message, however, the data parameter will be null, replaced by errors, e.g.:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "errors": [
    {
      "message": "limit must be less than or equal to 500",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "cryptoTradingPairs"
      ],
      "extensions": {
        "code": "BAD_USER_INPUT"
      }
    }
  ],
  "data": null
}

Yuzu uses the extensions object to specify a code which can be handled, e.g., BAD_USER_INPUT in the example above.