# Rate

## Module endpoints

* [`DELETE /rates/:baseAssetCode/:quoteAssetCode`](#delete-rates-baseassetcode-quoteassetcode)
* [`GET /rates`](#get-rates)
* [`GET /rates/:baseAssetCode/:quoteAssetCode`](#get-rates-baseassetcode-quoteassetcode)
* [`PATCH /rates/:baseAssetCode/:quoteAssetCode`](#patch-rates-baseassetcode-quoteassetcode)
* [`POST /rates`](#post-rates)

### `DELETE /rates/:baseAssetCode/:quoteAssetCode`

> `DELETE` <http://api.slyk.i&#x6F;**/rates/:baseAssetCode/:quoteAssetCode>\*\*

Deletes the `rate` between the `baseAssetCode` and `quoteAssetCode`.

{% tabs %}
{% tab title="Response" %}

> `204` No Content
> {% endtab %}
> {% endtabs %}

### `GET /rates`

> `GET` <https://api.slyk.i&#x6F;**/rates>\*\*

Returns a paginated list of `rates`.

{% tabs %}
{% tab title="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`                 |
| {% endtab %}       |                           |                                        |

{% tab title="Available Sorts" %}

| Name          | Example          |
| ------------- | ---------------- |
| **createdAt** | `sort=createdAt` |
| **rate**      | `sort=rate`      |
| **updatedAt** | `sort=updatedAt` |
| {% endtab %}  |                  |

{% tab title="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` |
| {% endtab %} |                                                         |                  |

{% tab title="Response" %}

```javascript
{
  "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
}
```

{% endtab %}
{% endtabs %}

### `GET /rates/:baseAssetCode/:quoteAssetCode`

> `GET` <https://api.slyk.i&#x6F;**/rates/:baseAssetCode/:quoteAssetCode>\*\*

Returns the `rate` between the `baseAssetCode` and `quoteAssetCode`.

{% tabs %}
{% tab title="Response" %}

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

{% endtab %}
{% endtabs %}

### `PATCH /rates/:baseAssetCode/:quoteAssetCode`

> `PATCH` <https://api.slyk.i&#x6F;**/rates/:baseAssetCode/:quoteAssetCode>\*\*

Patch the `rate` between the `baseAssetCode` and `quoteAssetCode`.

{% tabs %}
{% tab title="Request Parameters" %}

| Name           |   Type   | Required | Description                                      |
| -------------- | :------: | :------: | ------------------------------------------------ |
| **customData** | `object` |  `false` | Can store additional information about the rate. |
| **rate**       | `string` |  `false` | Rate value.                                      |
| {% endtab %}   |          |          |                                                  |

{% tab title="Request" %}

```javascript
{
  "rate": "6185.63"
}
```

{% endtab %}

{% tab title="Response" %}

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

{% endtab %}
{% endtabs %}

### `POST /rates`

> `POST` <https://api.slyk.i&#x6F;**/rates>\*\*

Creates a new `rate`.

{% tabs %}
{% tab title="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.                                      |
| {% endtab %}       |          |          |                                                  |

{% tab title="Request" %}

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

{% endtab %}

{% tab title="Response" %}

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

{% endtab %}
{% endtabs %}