REST API - GoldFund/goldfundapi GitHub Wiki

1. Base URL

The REST API has endpoints for account and trade management as well as public tickers data.

The request URL needs to be determined by BASE and specific endpoint combination.

2. Endpoint of the Interface

For the GET METHOD API, the endpoint needs to contain the query parameters string.
All requests and responses are application/json content type.
Unless otherwise stated, all timestamp parameters should be in milliseconds. e.g. 1544657962711

3. Parameters

For the GET, DELETE request, all query parameters need to be included in the request URL. (e.g. api/v1/ticker/price?symbol=ETH-BTC)
For the POST, PUT request, all query parameters need to be included in the request body with JSON. (e.g. {"symbol":"ETH-BTC"}). Do not include extra spaces in JSON strings.

4. Errors

When errors occur, the HTTP error code or system error code will be returned. The body will also contain a message parameter indicating the cause.

HTTP error status codes

Code	Meaning
400	Bad Request -- Invalid request format.
401	Unauthorized -- Invalid API Key.
403	Forbidden -- The request is forbidden.
404	Not Found -- The specified resource could not be found.
405	Method Not Allowed -- You tried to access the resource with an invalid method.
500	Internal Server Error -- We had a problem with our server. Try again later.