Documentation

Error handling

Error format

In case of not being able to successfully service a request the API will return an error response.

The API offers two categories of errors:

1. General Error – errors that do NOT result in creation of an order with an internal identifier.
2. Order Processing Error – errors that occur during processing of trade calls (e.g., placing, replacing, canceling an order) that result in an order being created in the platform.

General error response

General error message will consist of properties specified in the table below.

Sample

 
  HTTP/1.1 400 Bad Request
  Content-Length: 63
  Content-Type: application/json; charset=utf-8
  Date: Fri, 18 Aug 2014 22:17:16 GMT 
      {
          "code": 3139 ,
           "message": "Invalid route" 
      }   

Order processing error response

Whenever a trading call results in the creation of an order with a unique internal identifier, the platform will return an error response with additional properties (orderId and orders) in addition to standard error fields (code and message) in the response.

Sample order error response (no order created)

 
  HTTP/1.1 400 Bad Request
  Content-Length: 63
  Content-Type: application/json; charset=utf-8
  Date: Fri, 18 Aug 2014 22:17:16 GMT
      {
           "code": 3139,
           "message": "Invalid route"
      }  

Sample order error response (order created)

 
 HTTP/1.1 200 OK
 Content-Length: 63
 Content-Type: application/json; charset=utf-8
 Date: Fri, 18 Aug 2014 22:17:16 GMT 
      {
           "code": 3054 ,
           "message": "Order was rejected by the exchange" ,
           "orderId": 134353223 ,
           "orders": [
                ...
       ]
     }