xbullion API (v1.0)

Overview

This documentation describes the rules by which your applications can interact with xbullion via our API (Application Programming Interface). Use of the API must abide by xbullion's Token Terms of Sale for both GOLD & SILV.

The documentation also includes information providing guidance on how to interpret the response to your request, and example code for retrieving specific information from the server.

Intended use of the xbullion API is to allow clients to:

• Access and update information regarding their account and balance
• Retrieve orderbook market data
• Read, place and cancel trading orders
  
• Request orderbook quotes for a symbol

Important guidelines:
‍The API has both public and authenticated endpoints. Public endpoints are accessible to anyone i.e. no account or credentials are required, whereas Authenticated endpoints require the user to provide a valid access token. Endpoints can be retrieved using different methods such as a cURL entered in your browser, or running code – examples of both are provided in the documentation.

When placing an order, the minimum quantity is 0.00000001. The price precision for all endpoints is up to five significant digits e.g. 0.7249 or 14.378.

Regarding authentication, the following details are important to note.

Request formulation:
‍Requests to the API will always consist of the url of the endpoint you are accessing, as well as the header of your request. For some endpoints, a request payload is also required.

The base url for all endpoints is https://api.prod.xbullion.io. This is pre-pended to the path url listed in the documentation for a specific request. As an example, the url to test connectivity to the server is /api/v1/ping. Pre-pending the base url to the path url gives a complete url of https://api.prod.xbullion.io/api/v1/ping. 
NOTE: The ‘order’ and ‘quote’ endpoints have a trailing slash in the path url i.e. https://api.prod.xbullion.io/api/v1/order/, which must be present in order for a response to be received.

If additional path parameters are listed in the documentation of an endpoint, these are to be appended to the full request url. E.g., retrieving data on a specific order, with order_id = a1b2c3, the complete url becomes: https://api.prod.xbullion.io/api/v1/order/a1b2c3.

The header of your request must include the key:value pair of ‘accept’: ‘application/json’ to specify content type. Your access token will also need to be included in the header object, if retrieving data from an authenticated endpoint.

For endpoints requiring a payload, a body object will need to be included in the request, with the key:value pairs specified. The request body schema is application/json. Query parameters are also specified in the documentation of some endpoints, which will need to be included as a params object in your request.
NOTE: The parameters for a request (symbols, side etc.) are case-sensitive (‘GOLDUSD’ ≠ ‘goldusd’) and only uppercase inputs will be accepted.

‍‍‍Responses:
‍Successful requests return a 200 or 201 HTTP status code. Requests that generate errors return 4xx or 5xx status codes. More information on error codes is provided below, to assist with debugging.