Rate

Module endpoints

• DELETE /rates/:baseAssetCode/:quoteAssetCode

• GET /rates

• GET /rates/:baseAssetCode/:quoteAssetCode

• PATCH /rates/:baseAssetCode/:quoteAssetCode

• POST /rates

DELETE /rates/:baseAssetCode/:quoteAssetCode

DELETE http://api.slyk.io/rates/:baseAssetCode/:quoteAssetCode

Deletes the rate between the baseAssetCode and quoteAssetCode.

Response

204 No Content

GET /rates

GET https://api.slyk.io/rates

Returns a paginated list of rates.

Available Filters

Name	Type	Example
baseAssetCode	= in nin	filter[baseAssetCode]=in:usd,eur,btc
quoteAssetCode	= in nin	filter[quoteAssetCode]=nin:usd
rate	= gt gte lt lte	filter[rate]=gte:0.6

Available Sorts

Name	Example
createdAt	sort=createdAt
rate	sort=rate
updatedAt	sort=updatedAt

Paginate Options

Name	Description	Example
size	Defines the number of results per page. Default = 30.	page[size]=2
number	Defines the number of the page to retrieve. Default = 1	page[number]=2

Response

{
  "data": [
    {
      "baseAssetCode": "btc",
      "createdAt": "2019-03-20T14:30:37.483Z",
      "customData": {},
      "metadata": {},
      "quoteAssetCode": "eur",
      "rate": "6199.9000000",
      "updatedAt": "2019-03-20T14:30:37.483Z"
    },
    {
      "baseAssetCode": "btc",
      "createdAt": "2019-03-20T14:30:37.483Z",
      "customData": {},
      "metadata": {},
      "quoteAssetCode": "usd",
      "rate": "6670.1600000",
      "updatedAt": "2019-03-20T14:30:37.483Z"
    }
  ],
  "total": 2
}

GET /rates/:baseAssetCode/:quoteAssetCode

GET https://api.slyk.io/rates/:baseAssetCode/:quoteAssetCode

Returns the rate between the baseAssetCode and quoteAssetCode.

Response

{
  "data": {
    "baseAssetCode": "btc",
    "createdAt": "2019-03-20T14:30:37.483Z",
    "customData": {},
    "metadata": {},
    "quoteAssetCode": "eur",
    "rate": "6199.9000000",
    "updatedAt": "2019-03-20T14:30:37.483Z"
  }
}

PATCH /rates/:baseAssetCode/:quoteAssetCode

PATCH https://api.slyk.io/rates/:baseAssetCode/:quoteAssetCode

Patch the rate between the baseAssetCode and quoteAssetCode.

Request Parameters

Name	Type	Required	Description
customData	object	false	Can store additional information about the rate.
rate	string	false	Rate value.

Request

{
  "rate": "6185.63"
}

Response

{
  "data": {
    "baseAssetCode": "btc",
    "createdAt": "2019-03-20T14:30:37.483Z",
    "customData": {},
    "metadata": {},
    "quoteAssetCode": "eur",
    "rate": "6185.6300000",
    "updatedAt": "2019-03-20T14:30:37.483Z"
  }
}

POST /rates

POST https://api.slyk.io/rates

Creates a new rate.

Request Parameters

Name	Type	Required	Description
baseAssetCode	string	true	Base asset code.
customData	object	false	Can store additional information about the rate.
quoteAssetCode	string	true	Quote asset code
rate	string	true	Rate value.

Request

{
  "baseAssetCode": "btc",
  "quoteAssetCode": "eth",
  "rate": "48.86"
}

Response

{
  "data": {
    "baseAssetCode": "btc",
    "createdAt": "2019-03-20T14:30:37.483Z",
    "customData": {},
    "metadata": {},
    "quoteAssetCode": "eth",
    "rate": "48.8600000",
    "updatedAt": "2019-03-20T14:30:37.483Z"
  }
}