# Crypto API Documentation| GMO Coin

<a id="outline"></a>
# Introduction

GMO Coin provides a Public API that does not require authentication and a Private API that requires authentication using an API key.

* All requests from the client to the API are [HTTPS](https://en.wikipedia.org/wiki/HTTPS) communication.
* Only Spot and Margin trading are supported.

```javascript

//Request examples are tested with Node.js v21.0.0.

```

<a id="end-point"></a>
## Endpoint

* Public API: `https://api.coin.z.com/public`
* Public WebSocket API: `wss://api.coin.z.com/ws/public`
* Private API: `https://api.coin.z.com/private`
* Private WebSocket API: `wss://api.coin.z.com/ws/private`


<a id="version"></a>
## Version
Current version: `v1`


<a id="restrictions"></a>
## API Limiting
API usage Limits are below:

<a id="restrictions-public-ws-api"></a>
##### Public WebSocket API Limiting
* 1 request (subscribe/unsubscribe) per second from each IP address for Public WebSocket API.

<a id="restrictions-private-api"></a>
##### Private API Limiting
* Current week's private API limits are based on the trading volume from the previous week.
* Private API's limits are subject to change without prior notice.
* If you enable the IP restriction feature on the membership site, it will deny any API calling that comes from a non-registered IP.
* Only features that are specified on the membership site when API key was issued can be called.
* Permissions for the CryptoCurrency withdrawal APIs are separated for each API. These APIs can be called only with an API key that has the permission. See [Create API key](#api-key) for details.

|  Level  |  Volume  |  API limits  |  Description  |
| ---- | ---- | ---- | ---- |
|  Tier 1  |  Last week trading volume < 1,000,000,000yen  |  20req/s  |  Maximum 20 GET requests per second.  Maximum 20 POST requests per second. |
|  Tier 2  |  1,000,000,000yen <= Last week trading volume < 2,000,000,000yen  |  30req/s  | Maximum 30 GET requests per second.  Maximum 30 POST requests per second. |
|  Tier 3  |  Last week trading volume >= 2,000,000,000yen  |  50req/s  |  Maximum 50 GET requests per second.  Maximum 50 POST requests per second.  |

*Trading volume targets spot trading and margin trading of exchange. *Trading volume data will be collected between past Sunday 6:00 and current Sunday 5:59 JST. *Tier will be updated every Sunday between 6:00 - 6:30 JST.

<a id="restrictions-private-ws-api"></a>
##### Private WebSocket API Limiting
* Private WebSocket API is limited to maximum 1 request (subscribe/unsubscribe) per second for each IP address.
* If you enable the IP restriction feature on the membership site, it will deny any API calling that comes from a non-registered IP.
* Only features specified at the time of issuing the API key can be subscribed.

<a id="restrictions-other"></a>
##### Other
We may restrict API usage due to any of the following reasons.

* To automatically limit the flow rate when our entire system experiences overload.
* We have determined the user's API usage may be causing an overload on our system.
* We have determined that users are repeatedly placing orders to intentionally overload our system.


<a id="open-account"></a>
# Opening New Accounts
If you don't have an account　[Sign up for free](https://coin.z.com/jp/member/signup)


<a id="api-key"></a>
# Creating API Keys
After opening an account, you can create API keys from the membership site.

When you create an API key, you can set a permission for each functionality.

The following CryptoCurrency withdrawal APIs have a separate permission for each API. Give the API key the permission for each API you call. An API key without the permission cannot call that API.

* [CryptoCurrency withdrawal](#withdrawal)
* [Cancel CryptoCurrency withdrawal](#cancelWithdrawal)
* [CryptoCurrency withdrawal status](#withdrawalStatus)
* [Registered withdrawal addresses](#withdrawalAddresses)
* [Countries and regions](#withdrawalNations)
* [States and provinces](#withdrawalProvinces)
* [Withdrawal purposes](#withdrawalPurposes)

* Two-factor authentication is required to create, edit, or enable any API key, regardless of its permissions. Customers aged 18 or 19 cannot create or edit an API key with permissions for the CryptoCurrency withdrawal APIs.

* If an API key with permissions for the CryptoCurrency withdrawal APIs and its API secret are exposed to a third party, your cryptocurrency may be withdrawn to a registered address without any action on your part. Withdrawals via the API do not require two-factor authentication for each request.

Give withdrawal permissions only when needed, and disable the API key while you are not using the API. Enabling the IP restriction feature blocks API calls from unregistered IP addresses even if the API key is exposed (see [API Limiting](#restrictions)). You are responsible for keeping your API key and API secret strictly confidential.


<a id="authentication"></a>
# Authentication

Authentication is not required to callout the Public API. Public API functionalities are [here](#public-api).


<a id="authentication-private"></a>
## Private API

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://END_POINT_URL';
const path      = '/v1/PATH';
const reqBody   = JSON.stringify({});

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

HTTP header requires to include information with using API key and API secret below:

* API-KEY: Access key that is issued on the membership site
* API-TIMESTAMP: The request's Unix Timestamp
* API-SIGN: Signature generated for each request with the following method

##### Signature Generation

You can generate the signature by signing a concatenated string of the request's Unix Timestamp (milliseconds), the HTTP method, the request path, and the request body with your API secret key using the HMAC-SHA256 algorithm. Please pay special attention to the following:

* For GET requests, the request body must be an empty string.
* The request path must start with `/v1` and must not start with `/private`.

<a id="authentication-private-ws"></a>
## Private WebSocket API
Using a [Private API](#ws-auth-post) to get an access token. The way of authentication for the Private API is the same as the other Private API.

<a id="public-api"></a>
# Public API


<a id="status"></a>
## Service Status

> Request example:

```javascript
const axios = require('axios');

const endPoint = 'https://api.coin.z.com/public';
const path     = '/v1/status';

axios.get(endPoint + path)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {});
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "status": "OPEN"
  },
  "responsetime": "2019-03-19T02:15:06.001Z"
}
```

Gets the service status of GMO Coin.


##### Request
`GET /public/v1/status`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
status | string | Service status: `MAINTENANCE`（Service status: Maintenance） `PREOPEN`（Pre-open） `OPEN`（Open）


<a id="ticker"></a>
## Ticker

> Request example:

```javascript
const axios = require('axios');

const endPoint = 'https://api.coin.z.com/public';
const path     = '/v1/ticker?symbol=BTC';

axios.get(endPoint + path)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {});
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "ask": "750760",
      "bid": "750600",
      "high": "762302",
      "last": "756662",
      "low": "704874",
      "symbol": "BTC",
      "timestamp": "2018-03-30T12:34:56.789Z",
      "volume": "194785.8484"
    }
  ],
  "responsetime": "2019-03-19T02:15:06.014Z"
}
```

Gets the latest rates of the specified symbol. 
If you want to get all symbols' rates, we recommend calling out it without a symbol.


##### Request
`GET /public/v1/ticker`

##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Optional | If a symbol is not specified, returns all symbols' rates.The handling symbols are [here](#parameters-ref)

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
list.volume | string | Volume of trade in 24 hours.


<a id="orderbooks"></a>
## Order Books

> Request example:

```javascript
const endPoint = 'https://api.coin.z.com/public';
const path     = '/v1/orderbooks?symbol=BTC';

axios.get(endPoint + path)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {});
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "asks": [
      {
        "price": "455659",
        "size": "0.1"
      }
    ],
    "bids": [
      {
        "price": "455659",
        "size": "0.1"
      }
    ],
    "symbol": "BTC"
  },
  "responsetime": "2019-03-19T02:15:06.026Z"
}
```

Gets an order book (snapshot) of the specified symbol.


##### Request
`GET /public/v1/orderbooks`


##### Parameters
* Parameter type: query
 
Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
asks | array | Information of sell orders in ascending order of price.
bids | array | Information of buy orders in descending order of price.


<a id="trades"></a>
## Trade History

> Request example:

```javascript
const axios = require('axios');

const endPoint = 'https://api.coin.z.com/public';
const path     = '/v1/trades?symbol=BTC&page=1&count=10';

axios.get(endPoint + path)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {});
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "pagination": {
      "currentPage": 1,
      "count": 30
    },
    "list": [
      {
        "price": "750760",
        "side": "BUY",
        "size": "0.1",
        "timestamp": "2018-03-30T12:34:56.789Z"
      }
    ]
  },
  "responsetime": "2019-03-28T09:28:07.980Z"
}
```

Gets the trade history in descending order of timestamp for a specified symbol.


##### Request
`GET /public/v1/trades`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)
`page`（Target page） | number | Optional | Target page: If a page is not specified, it will run assuming 1 is set.
`count`（Number of items that you want to get in 1 page） | number | Optional | Number of items that you want to get in 1 page: If a count is not specified, it will run assuming 100 (maximum value) is set.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
price | string | Executed price
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
size | string | Executed quantity
timestamp | string | Executed timestamp

<a id="klines"></a>
## KLine Data

> Request example:

```javascript
const axios = require('axios');

const endPoint = 'https://api.coin.z.com/public';
const path     = '/v1/klines?symbol=BTC&interval=1min&date=20210417';

axios.get(endPoint + path)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {});
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
        "openTime":"1618588800000",
        "open":"6418255",
        "high":"6518250",
        "low":"6318250",
        "close":"6418253",
        "volume":"0.0001"
    },
    {
        "openTime":"1618588860000",
        "open":"6418251",
        "high":"6418252",
        "low":"6415250",
        "close":"6418245",
        "volume":"0.0001"
    }
  ],
  "responsetime": "2019-03-28T09:28:07.980Z"
}
```

Gets a market's OHLCV candlestick data (sorted by start time in ascending order) of the specified symbol.


##### Request
`GET /public/v1/klines`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol）       | string | Required | The handling symbols are [here](#parameters-ref)
`interval`（Chart type） | string | Required |  `1min`（1minute chart） `5min`（5minute chart） `10min`（10minute chart） `15min`（15minute chart） `30min`（30minute chart） `1hour`（1hour chart） `4hour`（4hour chart） `8hour`（8hour chart） `12hour`（12hour chart） `1day`（daily chart） `1week`（weekly chart） `1month`（monthly chart）
`date`（Search date） | string | Required |   Acceptable data formats: `YYYYMMDD`（date format） `YYYY`（year format）  If `YYYYMMDD` , the following interval values are supported: `1min`（Chart type: 1minute chart） `5min`（5minute chart） `10min`（10minute chart） `15min`（15minute chart） `30min`（30minute chart） `1hour`（1hour chart） *The date should be equal to or after 20210415. Date will be renewed at JST 6:00.  If `YYYY` , the following interval values are supported: `4hour`（4hour chart） `8hour`（8hour chart） `12hour`（12hour chart） `1day`（daily chart） `1week`（weekly chart） `1month`（monthly chart） *The date should be equal to or after the release date of each symbol. The release date is [here](#parameters-ref).

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
openTime | string | Start unix timestamp(milliseconds)
open | string | Open price
high | string | High price
low | string | Low price
close | string | Close price
volume | string | Volume of trade

<a id="symbols"></a>
## Trade rules

> Request example:

```javascript
const axios = require('axios');

const endPoint = 'https://api.coin.z.com/public';
const path     = '/v1/symbols';

axios.get(endPoint + path)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {});

```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "symbol": "BTC",
      "minOrderSize": "0.0001",
      "maxOrderSize": "5",
      "sizeStep": "0.0001",
      "tickSize": "1",
      "takerFee": "0.0005",
      "makerFee": "-0.0001"
    },
    {
      "symbol": "BTC_JPY",
      "minOrderSize": "0.01",
      "maxOrderSize": "5",
      "sizeStep": "0.01",
      "tickSize": "1",
      "takerFee": "0",
      "makerFee": "0"
    }
  ],
  "responsetime": "2022-12-15T19:22:23.792Z"
}
```

Gets trade rules.


##### Request
`GET /public/v1/symbols`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
symbol | string | The handling symbols are [here](#parameters-ref)
minOrderSize | string | Minimum order amount
maxOrderSize | string | Maximum order amount
sizeStep | string | Minimum order value
tickSize | string | Tick size
takerFee | string | Taker Fee
makerFee | string | Maker Fee

<a id="public-ws-api"></a>
# Public WebSocket API

* A ping will be sent from the server to a client once per minute. If there's no response (pong) from a client 3 consecutive times, then the WebSocket will be disconnected automatically.


<a id="ws-ticker"></a>
## Ticker

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/public/v1");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "ticker",
        "symbol": "BTC"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel":"ticker",
  "ask": "750760",
  "bid": "750600",
  "high": "762302",
  "last": "756662",
  "low": "704874",
  "symbol": "BTC",
  "timestamp": "2018-03-30T12:34:56.789Z",
  "volume": "194785.8484"
}
```

Gets the latest rates of the specified symbol. 
After `subscribe`（WebSocket Command: Start subscribing）, tickers start to be sent.


##### Parameters
* Parameter type: JSON

Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `ticker`（Channel Name: Ticker）
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `ticker`（Channel Name: Ticker）
ask | string | The best indicative price in the current selling orders.
bid | string | The best indicative price in the current buying orders.
high | string | The highest trading price of the day.
last | string | The latest trading price.
low | string | The lowest trading price of the day.
symbol | string | The handling symbols are [here](#parameters-ref)
timestamp | string | Executed timestamp.
volume | string | Volume of trade in 24 hours.

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.

<a id="ws-orderbooks"></a>
## Order Books

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/public/v1");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "orderbooks",
        "symbol": "BTC"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel":"orderbooks",
  "asks": [
    {"price": "455659","size": "0.1"},
    {"price": "455658","size": "0.2"}
  ],
  "bids": [
    {"price": "455665","size": "0.1"},
    {"price": "455655","size": "0.3"}
  ],
  "symbol": "BTC",
  "timestamp": "2018-03-30T12:34:56.789Z"
}
```

Gets an order book (snapshot) of the specified symbol. 
After `subscribe`（WebSocket Command: Start subscribing）, order books start to be sent.


##### Parameters
* Parameter type: JSON
 
Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `orderbooks`（Channel Name: Order Books）
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `orderbooks`（Channel Name: Order Books）
asks | array | Information of sell orders in ascending order of price.
bids | array | Information of buy orders in descending order of price.
symbol | string | The handling symbols are [here](#parameters-ref)
timestamp | string | Timestamp of the orderbook.

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.

<a id="ws-trades"></a>
## Trades

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/public/v1");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "trades",
        "symbol": "BTC"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel":"trades",
  "price": "750760",
  "side": "BUY",
  "size": "0.1",
  "timestamp": "2018-03-30T12:34:56.789Z",
  "symbol": "BTC"
}
```

Gets trade histories of the specified symbol. 
After `subscribe`（WebSocket Command: Start subscribing）, trade histories start to be sent.


##### Parameters
* Parameter type: JSON

Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `trades`（Channel Name: Trades）
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)
option | string | Optional | `TAKER_ONLY`（Option: Send taker data only.） *If option is specified, it will send taker data only. *If you request multiple trade subscriptions with the same symbol, only the latest request will be valid.


##### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `trades`（Channel Name: Trades）
price | string | Executed price
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
size | string | Executed quantity
timestamp | string | Executed timestamp
symbol | string | The handling symbols are [here](#parameters-ref)

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.


<a id="private-api"></a>
# Private API


<a id="margin"></a>
## Margin

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/margin';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "actualProfitLoss": "68286188",
    "availableAmount": "57262506",
    "availableAmountForSpot": "57262506",
    "cryptoShortfallStatus": "NORMAL",
    "margin": "1021682",
    "marginCallStatus": "NORMAL",
    "marginRatio": "6683.6",
    "profitLoss": "0",
    "transferableAmount": "57262506"
  },
  "responsetime": "2019-03-19T02:15:06.051Z"
}
```

Gets information of trading capacity.


##### Request
`GET /private/v1/account/margin`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
actualProfitLoss | string | The summary of the current evaluated amount
availableAmount | string | Available amount (including the collateral crypto-asset value, for leverage trading)
availableAmountForSpot | string | Available amount for spot trading (excluding the collateral crypto-asset value)
cryptoShortfallStatus | string | Crypto collateral shortfall status: `NORMAL`（Crypto collateral shortfall status: Normal） `SHORTFALL`（Shortfall in progress） `LIQUIDATION`（Liquidation in progress）
margin | string | Used margin
marginCallStatus | string | Marin call status: `NORMAL`（Margin call status: Normal） `MARGIN_CALL`（Margin call） `LOSSCUT`（Losscut）
marginRatio | string | Maintenance margin ratio
profitLoss | string | Appraisal profit or loss 
transferableAmount | string | Transferable amount 

<a id="assets"></a>
## Assets

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/assets';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "amount": "993982448",
      "available": "993982448",
      "conversionRate": "1",
      "symbol": "JPY"
    },
    {
      "amount": "4.0002",
      "available": "4.0002",
      "conversionRate": "859614",
      "symbol": "BTC"
    }
  ],
  "responsetime": "2019-03-19T02:15:06.055Z"
}
```

Retrieves asset data.


##### Request
`GET /private/v1/account/assets`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
amount | string | Amount
available | string | Available amount (Amount - Scheduled withdrawal amount)
conversionRate | string | JPY conversion rate (It is the selling price in the OTC Spot Market. *If the symbol is not listed in the OTC Spot Market, the final execution price in the Spot Trading will be used as the JPY conversion rate.)
symbol | string | Asset Ticker Symbol: The handling symbols are [here](#Asset-parameters-ref)  *Only symbols available on the exchange (Spot Trading) can be ordered by API.The handling symbols are [here](#parameters-ref)

<a id="tradingVolume"></a>
## Trading Volume

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/tradingVolume';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
      "jpyVolume": "9988888",
      "tierLevel": 1,
      "limit": [
         {
           "symbol": "BTC/JPY",
           "todayLimitOpenSize": "10000",
           "takerFee": "0",
           "makerFee": "0"
         },
         {
           "symbol": "BTC",
           "todayLimitBuySize": "98",
           "todayLimitSellSize": "102",
           "takerFee": "0.0015",
           "makerFee": "-0.0007"
         }
      ]
  },
  "responsetime": "2019-03-19T02:15:06.055Z"
}
```

Returns trading volume data.


##### Request
`GET /private/v1/account/tradingVolume`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
jpyVolume     | string | Current week's trading volume (Japanese Yen)
tierLevel     | number | Current [trading level](#restrictions): `1` `2` `3`
limit.symbol | string | The handling symbols are [here](#parameters-ref)
limit.todayLimitOpenSize  | string | Remaining size of maximum daily trading volume (Open)  *Margin symbols only
limit.todayLimitBuySize   | string | Remaining size of maximum daily trading volume (Buy)  *Spot symbols only
limit.todayLimitSellSize  | string | Remaining size of maximum daily trading volume (Sell)  *Spot symbols only
limit.takerFee  | string | Taker Fee
limit.makerFee  | string | Maker Fee

<a id="fiatDepositHistory"></a>
## Fiat deposit history

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/fiatDeposit/history';
const parameters = '?fromTimestamp=2024-03-01T00:00:00.000Z';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "amount": "50000",
      "fee": "0",
      "status": "EXECUTED",
      "symbol": "JPY",
      "timestamp": "2021-01-01T13:47:12.791Z"
    }
  ],
  "responsetime": "2024-02-28T11:48:57.996Z"
}
```

Returns JPY deposit history data.


##### Request
`GET /private/v1/account/fiatDeposit/history`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
fromTimestamp | string | Required | Start search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:00:00.000Z)  * When only fromTimestamp is specified, toTimestamp will be 'fromTimestamp + 30 minutes'.
toTimestamp | string | Optional | End search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:30:00.000Z)  * The maximum difference between fromTimestamp and toTimestamp is 30 minutes.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
amount     | string | amount
fee     | string | fee
status | string | status: `EXECUTED`
symbol  | string | symbol: `JPY`
timestamp | string | executed timestamp(UTC)

<a id="fiatWithdrawalHistory"></a>
## Fiat withdrawal history

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/fiatWithdrawal/history';
const parameters = '?fromTimestamp=2024-03-01T00:00:00.000Z';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "amount": "50000",
      "fee": "0",
      "status": "EXECUTED",
      "symbol": "JPY",
      "timestamp": "2021-01-01T13:47:12.791Z"
    }
  ],
  "responsetime": "2024-02-28T11:48:57.996Z"
}
```

Returns JPY withdrawal history data。


##### Request
`GET /private/v1/account/fiatWithdrawal/history`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
fromTimestamp | string | Required | Start search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:00:00.000Z)  * When only fromTimestamp is specified, toTimestamp will be 'fromTimestamp + 30 minutes'.
toTimestamp | string | Optional | End search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:30:00.000Z)  * The maximum difference between fromTimestamp and toTimestamp is 30 minutes.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
amount     | string | amount
fee     | string | fee
status | string | status: `EXECUTED`
symbol  | string | The handling symbols are [here](#parameters-ref): `JPY`
timestamp | string | executed timestamp(UTC)

<a id="depositHistory"></a>
## CryptoCurrency deposit history

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/deposit/history';
const parameters = '?symbol=BTC&fromTimestamp=2024-03-01T00:00:00.000Z';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "address": "xxx",
      "amount": "0.9503",
      "status": "EXECUTED",
      "symbol": "BTC",
      "timestamp": "2021-10-05T06:04:46.241Z",
      "txHash": "yyy"
    }
  ],
  "responsetime": "2024-02-28T12:20:07.103Z"
}
```

Returns CryptoCurrency deposit history data.


##### Request
`GET /private/v1/account/deposit/history`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
symbol | string | Required | The handling symbols are [here](#parameters-ref)
fromTimestamp | string | Required | Start search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:00:00.000Z)  * When only fromTimestamp is specified, toTimestamp will be 'fromTimestamp + 30 minutes'.
toTimestamp | string | Optional | End search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:30:00.000Z)  * The maximum difference between fromTimestamp and toTimestamp is 30 minutes.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
address     | string | address
amount     | string | amount
fee     | string | fee
status | string | status: `EXECUTED`
symbol  | string | The handling symbols are [here](#parameters-ref)
timestamp | string | executed timestamp(UTC)
txHash | string | transaction hash

<a id="withdrawalHistory"></a>
## CryptoCurrency withdrawal history

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/history';
const parameters = '?symbol=BTC&fromTimestamp=2024-03-01T00:00:00.000Z';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "address": "xxx",
      "amount": "0.9503",
      "status": "EXECUTED",
      "symbol": "BTC",
      "timestamp": "2021-10-05T06:04:46.241Z",
      "txHash": "yyy"
    }
  ],
  "responsetime": "2024-02-28T12:20:07.103Z"
}
```

Returns CryptoCurrency withdrawal history data.


##### Request
`GET /private/v1/account/withdrawal/history`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
symbol | string | Required | The handling symbols are [here](#parameters-ref)
fromTimestamp | string | Required | Start search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:00:00.000Z)  * When only fromTimestamp is specified, toTimestamp will be 'fromTimestamp + 30 minutes'.
toTimestamp | string | Optional | End search (UTC): YYYY-MM-DDTHH:MM:SS.SSSZ format string (e.g. 2023-03-01T00:30:00.000Z)  * The maximum difference between fromTimestamp and toTimestamp is 30 minutes.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
address     | string | address
amount     | string | amount
fee     | string | fee
status | string | status: `EXECUTED`
symbol  | string | The handling symbols are [here](#parameters-ref)
timestamp | string | executed timestamp(UTC)
txHash | string | transaction hash

<a id="withdrawalAddresses"></a>
## Registered withdrawal addresses

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto/addresses';
const parameters = '?symbol=ETH';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "addressId": 858872,
        "symbol": "ETH",
        "name": "メタマスクETH",
        "address": "0x0785Ee6A44543aDAC0607A656AEa2e2c96c266f7",
        "chainType": 0,
        "vaspType": "PRIVATE",
        "vaspName": null,
        "receiverType": "SELF",
        "sendable": true,
        "sendableFrom": null
      }
    ]
  },
  "responsetime": "2026-11-14T02:00:00.456Z"
}
```

Returns the registered addresses that can be used for CryptoCurrency withdrawal. 
Addresses that have been registered and have passed the review on the membership site are returned. Both external addresses and GMO Coin accounts are included. Addresses that are under review, rejected, or invalid are not included. Addresses for which the membership site asks you to enter additional recipient information are not included either (including addresses of crypto-asset service providers not connected to Sygna whose country of location has not been entered). Once the additional information has been entered and reviewed on the membership site, the address is included in the list. 
* Addresses can be registered, changed, or deleted only on the membership site, not via the API. 
* An address cannot be used for withdrawal for 24 hours after we send you the email notifying you that the review of the address is complete. An address whose sendable is false can be used on or after the date and time in sendableFrom. 
* If you specify the addressId of an address that is not included in the list in [CryptoCurrency withdrawal](#withdrawal), ERR-5138 is returned.


##### Request
`GET /private/v1/account/withdrawal/crypto/addresses`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
symbol | string | Required | The handling symbols are [here](#parameters-ref)  * Specify one symbol per request.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
list[].addressId | number | Address ID. Specify this value as addressId in [CryptoCurrency withdrawal](#withdrawal).
list[].symbol | string | The handling symbols are [here](#parameters-ref)
list[].name | string | Name of the address registered on the membership site
list[].address | string | Destination address. For a GMO Coin account, this is the deposit address of the destination account.
list[].chainType | number | chain type: `0`（chain type: The asset's native blockchain） `1`（Optimism (Ethereum L2)）
list[].vaspType | string | address type: `PRIVATE`（address type: Private wallet） `INTERNAL`（GMO Coin account） `OTHER_VASP`（Crypto-asset service provider (not connected to Sygna)） `SYGNA_VASP`（Crypto-asset service provider (connected to Sygna)）
list[].vaspName | string | Name of the destination crypto-asset service provider. Set only when the address type is SYGNA_VASP or OTHER_VASP; otherwise null.
list[].receiverType | string | receiver type: `SELF`（receiver type: Yourself） `THIRD_PARTY`（Third party） null for addresses that are neither yourself nor a third party.
list[].sendable | bool | Whether the address can be used for withdrawal now. false within 24 hours after we send you the email notifying you that the review of the address is complete.
list[].sendableFrom | string | Date and time (UTC) when the address becomes available for withdrawal, set only when sendable is false; otherwise null.


<a id="withdrawalPurposes"></a>
## Withdrawal purposes

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto/purposes';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "purposeCode": 2,
        "name": "暗号資産の保管",
        "nameEn": "Storage of crypto assets",
        "requiresText": false,
        "requiresTradeDetails": false,
        "manualReview": false
      },
      {
        "purposeCode": 13,
        "name": "輸入品代金の支払い",
        "nameEn": "Payment for imported goods",
        "requiresText": false,
        "requiresTradeDetails": true,
        "manualReview": true
      }
    ]
  },
  "responsetime": "2026-11-14T02:00:00.456Z"
}
```

Returns the list of withdrawal purposes that can be specified in [CryptoCurrency withdrawal](#withdrawal). 
* When you specify a purpose whose requiresText is true, purposeText is required. When you specify a purpose whose requiresTradeDetails is true (trade-related), tradeDetails is required. 
* Purposes whose manualReview is true are subject to a manual review by GMO Coin, and the review takes time to complete. 
* Only the purposes that can be specified for your account type are returned. For general corporation accounts, 1, 2, 26, and 99 are returned. For special corporation accounts, the same purposes as individual accounts are returned. Specifying a purpose code that is not in the list returns ERR-5153 when the request is received.


##### Request
`GET /private/v1/account/withdrawal/crypto/purposes`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
list[].purposeCode | number | Purpose code. Specify this value as purposeCode in [CryptoCurrency withdrawal](#withdrawal).
list[].name | string | Name of the purpose (in Japanese)
list[].nameEn | string | Name of the purpose (in English)
list[].requiresText | bool | If true, purposeText is required.
list[].requiresTradeDetails | bool | If true, tradeDetails is required.
list[].manualReview | bool | If true, the purpose is subject to a manual review (the review takes time).


<a id="withdrawalNations"></a>
## Countries and regions

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto/nations';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "countryCode": "JPN",
        "name": "日本",
        "hasProvinces": true
      },
      {
        "countryCode": "CAN",
        "name": "カナダ",
        "hasProvinces": false
      }
    ]
  },
  "responsetime": "2026-11-14T02:00:00.456Z"
}
```

Returns the list of countries and regions to be specified as locations in tradeDetails of [CryptoCurrency withdrawal](#withdrawal) when the purpose is trade-related. 
* The list also includes countries and regions to which we do not allow withdrawals. A request that specifies such a country or region as a location is rejected (REJECTED) in the review of the withdrawal purpose after acceptance.


##### Request
`GET /private/v1/account/withdrawal/crypto/nations`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
list[].countryCode | string | Country or region code (ISO 3166-1 alpha-3)
list[].name | string | Name of the country or region (in Japanese)
list[].hasProvinces | bool | For countries and regions where this is true (Japan, the United States, and China), specify regionCode in the location. Otherwise, specify cityName.


<a id="withdrawalProvinces"></a>
## States and provinces

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto/provinces';
const parameters = '?countryCode=JPN';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "regionCode": "010",
        "name": "北海道"
      },
      {
        "regionCode": "020",
        "name": "青森県"
      }
    ]
  },
  "responsetime": "2026-11-14T02:00:00.456Z"
}
```

Returns the list of states and provinces to be specified as locations in tradeDetails of [CryptoCurrency withdrawal](#withdrawal) when the purpose is trade-related. 
* regionCode is assigned per country or region, so the same value may appear in different countries. Always use it together with countryCode. 
* If you specify a country or region that has no states or provinces, or a country code that does not exist, no error occurs and list is returned as an empty array. If countryCode is not three uppercase letters, ERR-5106 is returned.


##### Request
`GET /private/v1/account/withdrawal/crypto/provinces`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
countryCode | string | Required | Country or region code (ISO 3166-1 alpha-3). Specify a country or region whose hasProvinces is true in [Countries and regions](#withdrawalNations).

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
list[].regionCode | string | State or province code (3-digit string, e.g. 010)
list[].name | string | Name of the state or province (in Japanese)


<a id="withdrawal"></a>
## CryptoCurrency withdrawal

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto';
const reqBody   = JSON.stringify({
    clientOrderId: "withdrawal001",
    symbol: "ETH",
    addressId: 858872,
    sendAmount: "0.1",
    purposeCode: 2
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "orderId": 26145170,
    "clientOrderId": "withdrawal001",
    "symbol": "ETH",
    "addressId": 858872,
    "sendAmount": "0.1",
    "fee": "0.0004",
    "apiFee": "0.0004",
    "apiFeeJpy": "220",
    "rate": "550000",
    "status": "UNDER_REVIEW",
    "acceptedAt": "2026-11-14T02:00:00.000Z"
  },
  "responsetime": "2026-11-14T02:00:00.456Z"
}
```

> tradeDetails example:

```json
{
  "clientOrderId": "withdrawal002",
  "symbol": "BTC",
  "addressId": 850509,
  "sendAmount": "0.05",
  "purposeCode": 13,
  "tradeDetails": {
    "receiverLocation": { "countryCode": "JPN", "regionCode": "010", "cityName": null },
    "itemName": "食料品",
    "originLocation": { "countryCode": "CHN", "regionCode": "004", "cityName": null },
    "shipmentLocation": { "countryCode": "CAN", "regionCode": null, "cityName": "Vancouver" }
  }
}
```

Requests a CryptoCurrency withdrawal to a registered address. 
Specify the destination with addressId, which can be obtained from [Registered withdrawal addresses](#withdrawalAddresses). The network of the address can be checked with chainType returned by that API. 
An API withdrawal fee is charged for each withdrawal request. For the fee amount, see [Fees](https://coin.z.com/jp/corp/guide/fees/). The fee is converted into the amount of CryptoCurrency at our buying price (BID) at the time of the request, rounded up to the number of decimal places defined for each symbol, and collected from your balance of that CryptoCurrency separately from the withdrawal amount. The same applies when the destination is a GMO Coin account. 
* Because the fee is converted at the rate at the time of the request, it varies for each request. You can check the collected fee in fee and apiFee in the response. * Because the fee is collected from your balance of that CryptoCurrency separately from the withdrawal amount, specifying your entire holding results in insufficient balance (ERR-208). For DOT, ERR-5155 is returned instead if the amount is below the minimum withdrawal amount. Withdraw any holding below the minimum withdrawal amount from the membership site. 
Withdrawal requests subject to review are sent after a review by GMO Coin. Withdrawals to a GMO Coin account are not subject to review, and their status is PROCESSING at acceptance. Check the status after acceptance with [CryptoCurrency withdrawal status](#withdrawalStatus). 
* ERR-5004, a system error such as ERR-5000, an HTTP 5xx status, or a timeout does not mean that the withdrawal request failed. The request may have been accepted, so check the result by calling [CryptoCurrency withdrawal status](#withdrawalStatus) with clientOrderId. Requesting again with the same clientOrderId returns ERR-915, so the withdrawal is not made twice. * If you request again with a new clientOrderId and the earlier request had been accepted, the withdrawal is made twice. Request again only after [CryptoCurrency withdrawal status](#withdrawalStatus) returns ERR-5158 (not accepted). Immediately after a request, processing may not have finished and the request may not be found yet, so check again after a while. 
* If a location falls under a country or region to which we do not allow withdrawals, the request is not rejected at acceptance; after acceptance, it is rejected (REJECTED) in the review of the withdrawal purpose. 
* Withdrawals within one month of account opening that exceed the limit based on your declared financial assets category are not accepted via the API (ERR-5141). 
* A withdrawal request can be canceled only when the address type is SYGNA_VASP and it is waiting for the review. For details, see [Cancel CryptoCurrency withdrawal](#cancelWithdrawal). 
* For an example of tradeDetails for a trade-related purpose, see the tradeDetails example below the Response example. 
* A withdrawal request for the same symbol can be made only once per second per account. Exceeding this returns ERR-5003. A request rejected by the validation at acceptance (such as an input error) is not counted toward this limit. A request rejected after acceptance by the balance or limit checks (such as ERR-208 for insufficient balance or ERR-5157 for exceeding the daily withdrawal limit) is counted. Withdrawal requests for a different symbol are not subject to this limit.


##### Request
`POST /private/v1/account/withdrawal/crypto`


##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`clientOrderId`（Client order id） | string | Required | An order identifier assigned by the client. *Only combinations of up to 36 single-byte alphanumeric characters can be used. *Case-sensitive. *It must be unique within the account, and a clientOrderId that has been used before cannot be reused. However, the clientOrderId of a request rejected with an error on acceptance can be reused. The clientOrderId of a request rejected in the review cannot be reused. *ERR-915 is returned if a clientOrderId that has already been used is specified, regardless of the content of the request. Use a new value for each request. When ERR-915 is returned, you can check the result of the original request by calling [CryptoCurrency withdrawal status](#withdrawalStatus) with the same clientOrderId. *If you use a UUID, specify it as 32 hexadecimal characters with the hyphens removed.
symbol | string | Required | The handling symbols are [here](#parameters-ref)  Specify the same symbol as the address of addressId.
addressId | number | Required | Address ID obtained from [Registered withdrawal addresses](#withdrawalAddresses)
sendAmount | string | Required | Withdrawal amount. Specify a positive number with no more decimal places than the symbol allows. The specified amount is sent as is, and the fee is collected from your balance separately. For withdrawal conditions such as the minimum withdrawal amount and the daily withdrawal limit, see [here](https://coin.z.com/jp/corp/guide/deposit-withdrawal/).
purposeCode | number | *Required unless the address type is INTERNAL (a GMO Coin account) | Purpose code. Obtain the available values from [Withdrawal purposes](#withdrawalPurposes). Cannot be specified when the address type is INTERNAL (a GMO Coin account) (ERR-5153).
purposeText | string | *Required when requiresText of the purpose is true | Description of the purpose (free text, up to 400 characters). Cannot be specified when requiresText of the purpose is false.
tradeDetails | object | *Required when requiresTradeDetails of the purpose is true | Trade-related information. It cannot be specified for purposes whose requiresTradeDetails is not true (other than trade-related purposes).
tradeDetails.receiverLocation | object | Required | Location of the cargo receiver (Location)
tradeDetails.itemName | string | Required | Name of the imported goods (up to 256 characters)
tradeDetails.originLocation | object | Required | Place of origin (Location)
tradeDetails.shipmentLocation | object | Required | Place of shipment (where the cargo is loaded) (Location)

* For Location (receiverLocation, originLocation, and shipmentLocation), specify an object with the following properties.

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
countryCode | string | Required | Country or region code (ISO 3166-1 alpha-3). countryCode from [Countries and regions](#withdrawalNations)
regionCode | string | *Required for countries and regions whose hasProvinces is true | State or province code. regionCode from [States and provinces](#withdrawalProvinces). It cannot be specified for countries and regions whose hasProvinces is false.
cityName | string | *Required for countries and regions whose hasProvinces is false | City name (up to 256 characters). It cannot be specified for countries and regions whose hasProvinces is true.

* Specify exactly one of regionCode and cityName. Set the other to null or omit it.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
orderId | number | Order ID. Specify this value in [CryptoCurrency withdrawal status](#withdrawalStatus) and [Cancel CryptoCurrency withdrawal](#cancelWithdrawal).
clientOrderId | string | clientOrderId specified in the withdrawal request
symbol | string | The handling symbols are [here](#parameters-ref)
addressId | number | Address ID
sendAmount | string | Withdrawal amount
fee | string | Total withdrawal fee (amount of CryptoCurrency). The same value as the fee shown in the transaction history on the membership site.
apiFee | string | Amount of the API withdrawal fee included in fee
apiFeeJpy | string | API withdrawal fee (JPY)
rate | string | Rate used to convert the fee (our buying price (BID), JPY)
status | string | withdrawal status: `UNDER_REVIEW`（withdrawal status: Under review. The request has been accepted and is being reviewed.） `PROCESSING`（Processing. The review has been completed, and the withdrawal is waiting to be sent or waiting for confirmation on the blockchain.） `EXECUTED`（Executed. The withdrawal has been completed.） `CANCELED`（Canceled. The withdrawal was canceled by you or by GMO Coin.） `REJECTED`（Rejected. The withdrawal was rejected in the review or by the destination crypto-asset service provider.） `ERROR`（Error. The withdrawal failed to be sent. Please contact us regarding your balance.）
acceptedAt | string | Accepted timestamp (UTC). Precise to the second (milliseconds are always 000). For withdrawals subject to the review, this is the same value as the accepted timestamp returned by CryptoCurrency withdrawal status.


<a id="withdrawalStatus"></a>
## CryptoCurrency withdrawal status

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto/status';
const parameters = '?orderId=26145170';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "orderId": 26145170,
    "clientOrderId": "withdrawal001",
    "symbol": "ETH",
    "addressId": 858872,
    "sendAmount": "0.1",
    "fee": "0.0004",
    "apiFee": "0.0004",
    "status": "EXECUTED",
    "cancelable": false,
    "txHash": [
      "0x40320c23e98939b724eda46e4eadac82e112309fdba82273b179988cf210569a"
    ],
    "acceptedAt": "2026-11-14T02:00:00.000Z",
    "updatedAt": "2026-11-14T02:06:14.000Z"
  },
  "responsetime": "2026-11-14T02:10:00.456Z"
}
```

Returns the status of the specified CryptoCurrency withdrawal request. 
Specify either orderId or clientOrderId. 
* ERR-5158 is returned if no matching withdrawal request is found (an order ID that does not exist, an order of another account, or an order other than a withdrawal). 
* While a withdrawal is waiting to be sent after the review, its status is PROCESSING. A withdrawal request in PROCESSING cannot be canceled. If PROCESSING continues for a long time, please contact us. 
Completed (EXECUTED) withdrawals can also be obtained from [CryptoCurrency withdrawal history](#withdrawalHistory). 
* ERR-5212 is returned if both orderId and clientOrderId are specified, and ERR-5106 is returned if neither is specified or the format is invalid.


##### Request
`GET /private/v1/account/withdrawal/crypto/status`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderId`（Order id） | number | * | Order ID of the withdrawal request
`clientOrderId`（Client order id） | string | * | clientOrderId specified in the withdrawal request

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
orderId | number | Order id
clientOrderId | string | clientOrderId specified in the withdrawal request. null if not set.
symbol | string | The handling symbols are [here](#parameters-ref)
addressId | number | Address ID. null if it cannot be obtained.
sendAmount | string | Withdrawal amount
fee | string | Total withdrawal fee (amount of CryptoCurrency). The same value as the fee shown in the transaction history on the membership site.
apiFee | string | Amount of the API withdrawal fee included in fee. null if no API withdrawal fee is recorded.
status | string | withdrawal status: `UNDER_REVIEW`（withdrawal status: Under review. The request has been accepted and is being reviewed.） `PROCESSING`（Processing. The review has been completed, and the withdrawal is waiting to be sent or waiting for confirmation on the blockchain.） `EXECUTED`（Executed. The withdrawal has been completed.） `CANCELED`（Canceled. The withdrawal was canceled by you or by GMO Coin.） `REJECTED`（Rejected. The withdrawal was rejected in the review or by the destination crypto-asset service provider.） `ERROR`（Error. The withdrawal failed to be sent. Please contact us regarding your balance.）
cancelable | bool | Whether a cancellation request can be accepted. true only when the address type is SYGNA_VASP and the request is waiting for the review. false when a cancellation has already been requested or when the status is other than UNDER_REVIEW (such as CANCELED or ERROR).
txHash | array | Array of transaction hashes. An empty array before the withdrawal is sent. Contains multiple values if the withdrawal was sent in multiple transactions. If the destination is a GMO Coin account, it remains an empty array even after completion.
acceptedAt | string | Accepted timestamp (UTC). Precise to the second (milliseconds are always 000). null for withdrawals that are not subject to the review, such as some withdrawals to GMO Coin accounts.
updatedAt | string | Last updated timestamp (UTC). null if it cannot be obtained.


<a id="cancelWithdrawal"></a>
## Cancel CryptoCurrency withdrawal

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/withdrawal/crypto/cancel';
const reqBody   = JSON.stringify({
    orderId: 26145188
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "orderId": 26145188,
    "status": "UNDER_REVIEW",
    "cancelRequested": true
  },
  "responsetime": "2026-11-14T02:00:00.456Z"
}
```

Requests cancellation of a CryptoCurrency withdrawal request. 
Cancellation is possible only for withdrawal requests whose address type is SYGNA_VASP (a crypto-asset service provider connected to Sygna) and only while waiting for the review (the same condition as on the membership site). Withdrawal requests with other address types cannot be canceled. 
You can check whether a request can be canceled with cancelable in [CryptoCurrency withdrawal status](#withdrawalStatus). 
* A successful response indicates that the cancellation request has been accepted, not that the cancellation has been completed. Check the completion of the cancellation (CANCELED) with [CryptoCurrency withdrawal status](#withdrawalStatus). 
* You can also cancel on the membership site under the same condition.


##### Request
`POST /private/v1/account/withdrawal/crypto/cancel`


##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderId`（Order id） | number | Required | Order ID of the withdrawal request to cancel

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
orderId | number | Order id
status | string | Withdrawal status at the time the cancellation request was accepted (remains UNDER_REVIEW until the cancellation is completed)
cancelRequested | bool | Whether the cancellation request has been accepted

<a id="exchangeFeeHistory"></a>
## Exchange Fee History

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'GET';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/exchangeFee/history';
const parameters = '?fromDate=20260601&toDate=20260607';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "pagination": {
      "cursor": "AbzejT4z9R01mjvOj_APz3Y34AQmWAQenEVr07RfrVCbAmJZi9vgFexNTqKFYU9uW7rArTHokipb0gXMElEvu2v90QAey3haCOB9"
    },
    "list": [
      {
        "symbol": "BTC_JPY",
        "feeType": "LEVERAGE_FEE",
        "deliveryDate": "20260615",
        "deliveryDatetime": "2026-06-15T21:01:23.456Z",
        "deliveryAmount": "-120"
      },
      {
        "symbol": "BTC",
        "feeType": "SPOT_FEE_REFUND",
        "deliveryDate": "20260615",
        "deliveryDatetime": "2026-06-15T21:01:21.229Z",
        "deliveryAmount": "4"
      }
    ],
    "lastFinalizedDate": "20260615"
  },
  "responsetime": "2026-07-03T11:48:57.996Z"
}
```

Returns exchange fee refund (fractional refund of spot and margin trading fees) and exchange margin fee collection history data. 
Each record represents one business day per symbol and fee type. 
Records are returned newest first (descending by business day; within the same business day, most recently recorded first). 
* Leverage trading (Crypto FX) fees are not included. 
Records are created by a daily batch process after each business day closes (a business day runs 6:00 to 5:59 JST the next day). 
If the business day you want to query is on or before lastFinalizedDate, records for that business day are complete (an empty result can be treated as a confirmed absence of fees/refunds for that day). For business days after lastFinalizedDate, the daily batch is still processing; retry after a while. 
lastFinalizedDate reflects the value at response time. It may advance while you are paging through continued results. Records added after it advances cannot be retrieved with the cursor in use. Restart without a cursor when a complete result set is required. 
* No record is created for exchange margin fee on a day with no open position or a 0% interest rate. Fee refunds are also not created when the total is 0 yen. 
* If the history query times out, ERR-5016 is returned. Retry the same request first; if the error persists, narrow the fromDate/toDate range.


##### Request
`GET /private/v1/account/exchangeFee/history`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
fromDate | string | Required | Start business day: YYYYMMDD format string (e.g. 20260601)  * Must be on or before toDate. Future business days cannot be specified.
toDate | string | Optional | End business day: YYYYMMDD format string (e.g. 20260607)  * When not specified, toDate will be the same business day as fromDate (single-day search). * The maximum difference between fromDate and toDate is 7 days.
count | number | Optional | Maximum number of items per page  * The allowed range is 1 to 100. The default value is 100.
cursor | string | Optional | Specify the pagination.cursor of the previous response to get the next page.  * When cursor is specified, fromDate/toDate must be the same as the previous request.  * The next page contains older records (list is returned newest first).

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
pagination.cursor | string | continuation token, set only when the next page exists
list[].symbol | string | symbol of the trade the fee was incurred on (Spot: BTC etc. / Margin: BTC_JPY etc.)
list[].feeType | string | fee type: `LEVERAGE_FEE`（fee type: exchange margin fee charged） `SPOT_FEE_REFUND`（fractional refund of spot trading fee） `LEVERAGE_FEE_REFUND`（fractional refund of margin trading fee）
list[].deliveryDate | string | target business day (YYYYMMDD)
list[].deliveryDatetime | string | recorded timestamp(UTC)
list[].deliveryAmount | string | amount (JPY). Positive for refunds, negative for collections.
lastFinalizedDate | string | the latest business day (YYYYMMDD) for which the daily batch process (posting fees / reflecting refunds) has completed. Records up to and including this date are finalized. Not returned for an account whose daily batch process has never completed.

<a id="orders"></a>
## Orders

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp  = Date.now().toString();
const method     = 'GET';
const endPoint   = 'https://api.coin.z.com/private';
const path       = '/v1/orders';
const parameters = '?orderId=123456789,223456789';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "orderId": 223456789,
        "clientOrderId": "abc123",
        "rootOrderId": 223456789,
        "symbol": "BTC_JPY",
        "side": "BUY",
        "orderType": "NORMAL",
        "executionType": "LIMIT",
        "settleType": "OPEN",
        "size": "0.02",
        "executedSize": "0.02",
        "price": "1430001",
        "losscutPrice": "0",
        "status": "EXECUTED",
        "timeInForce": "FAS",
        "timestamp": "2020-10-14T20:18:59.343Z"
      },
      {
        "rootOrderId": 123456789,
        "orderId": 123456789,
        "symbol": "BTC",
        "side": "BUY",
        "orderType": "NORMAL",
        "executionType": "LIMIT",
        "settleType": "OPEN",
        "size": "1",
        "executedSize": "0",
        "price": "900000",
        "losscutPrice": "0",
        "status": "CANCELED",
        "cancelType": "USER",
        "timeInForce": "FAS",
        "timestamp": "2019-03-19T02:15:06.059Z"
      }
    ]
  },
  "responsetime": "2019-03-19T02:15:06.059Z"
}
```

Gets the order information of the specified order id or client order id. 
Target: Spot and Margin trading

* Either `orderId` or `clientOrderId` is required. Only one of them can be set at a time.


##### Request
`GET /private/v1/orders`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderId`（Order id） | string | * | Either `orderId` or `clientOrderId`（Client order id） is required. A comma-separated list of order ids. The maximum number of order ids is 10.
`clientOrderId`（Client order id） | string | * | Either `orderId`（Order id） or `clientOrderId` is required. *Only combinations of up to 36 single-byte alphanumeric characters can be used. *A comma-separated list of clientOrderIds. The maximum number of clientOrderIds is 10. The length limit applies to each clientOrderId.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
rootOrderId | number | Root order id
orderId | number | Order id
clientOrderId | string | Client order id *Returned only when set
symbol | string | The handling symbols are [here](#parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
orderType | string | Order Type: `NORMAL`（Order Type: Normal order (excludes margin liquidation)） `LOSSCUT`（Margin liquidation）
executionType | string | Execution Type: `MARKET`（Execution Type: Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
settleType | string | Settlement Type: `OPEN`（Settlement Type: Open position） `CLOSE`（Close postion）
size | string | Quantity of the order
executedSize | string | Executed quantity
price | string | Price of the order (This property is not included if the order is `MARKET`（Execution Type: Market order）.)
losscutPrice | string | Margin Liquidation (It should be "0" if the order is Spot trading or losscutPrice is not set.)
status | string | Order Status: `WAITING`（Order Status: Waiting *Valid for stop limit orders.） `ORDERED`（Valid or partially executed *Partially executed for stop limit orders.） `MODIFYING`（Modifying） `CANCELLING`（Cancelling） `CANCELED`（Canceled） `EXECUTED`（Executed） `EXPIRED`（Expired）  *`WAITING`  is valid for stop limit orders.
cancelType | string | Cancel Type: `USER`（Cancel Type: Canceled by the user.） `POSITION_LOSSCUT`（Canceled the margin trading order due to the position loss-cut.） `INSUFFICIENT_BALANCE`（Canceled the order due to the insufficient available amount. (Spot trading)） `INSUFFICIENT_MARGIN`（Canceled the order due to the insufficient available amount. (Margin trading)） `ACCOUNT_LOSSCUT`（Canceled the margin trading order because of insufficient balance in your account due to loss-cut.） `MARGIN_CALL`（Order canceled due to a margin call.） `MARGIN_CALL_LOSSCUT`（Settlement order canceled due to a losscut from a margin call.） `EXPIRED_FAK`（Expired by FAK） `EXPIRED_FOK`（Expired by FOK） `EXPIRED_SOK`（Expired by SOK） `EXPIRED_SELFTRADE`（Expired due to Self-trade.） `COLLATERAL_LIQUIDATION`（Order canceled due to collateral crypto-asset liquidation） *It is returned if status is `CANCELLING`, `CANCELED`, or `EXPIRED`.
timeInForce | string | Time in force: `FAK`（Time in force: Fill and kill. When an order can only be partially executed and its remaining part expires.） `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） (`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order)
timestamp | string | Ordered timestamp

<a id="active-orders"></a>
## Active Orders

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp  = Date.now().toString();
const method     = 'GET';
const endPoint   = 'https://api.coin.z.com/private';
const path       = '/v1/activeOrders';
const parameters = '?symbol=BTC&page=1&count=10';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "pagination": {
      "currentPage": 1,
      "count": 30
    },
    "list": [
      {
        "rootOrderId": 123456789,
        "orderId": 123456789,
        "clientOrderId": "abc123",
        "symbol": "BTC",
        "side": "BUY",
        "orderType": "NORMAL",
        "executionType": "LIMIT",
        "settleType": "OPEN",
        "size": "1",
        "executedSize": "0",
        "price": "840000",
        "losscutPrice": "0",
        "status": "ORDERED",
        "timeInForce": "FAS",
        "timestamp": "2019-03-19T01:07:24.217Z"
      }
    ]
  },
  "responsetime": "2019-03-19T01:07:24.217Z"
}
```

Gets active orders list of the specified symbol. 
Target: Spot and Margin trading


##### Request
`GET /private/v1/activeOrders`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)
`page`（Target page） | number | Optional | Target page: If a page is not specified, it will run assuming 1 is set.
`count`（Number of items that you want to get in 1 page） | number | Optional | Number of items that you want to get in 1 page: If a count is not specified, it will run assuming 100 (maximum value) is set.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
rootOrderId | number | Root order id
orderId | number | Order id
clientOrderId | string | Client order id *Returned only when set
symbol | string | The handling symbols are [here](#parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
orderType | string | Order Type: `NORMAL`（Order Type: Normal order (excludes margin liquidation)） `LOSSCUT`（Margin liquidation）
executionType | string | Execution Type: `MARKET`（Execution Type: Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
settleType | string | Settlement Type: `OPEN`（Settlement Type: Open position） `CLOSE`（Close postion）
size | string | Quantity of the order
executedSize | string | Executed quantity
price | string | Price of the order (This property is not included if the order is `MARKET`（Execution Type: Market order）.)
losscutPrice | string | Margin Liquidation (It should be "0" if the order is Spot trading or losscutPrice is not set.)
status | string | Order Status: `WAITING`（Order Status: Waiting *Valid for stop limit orders.） `ORDERED`（Valid or partially executed *Partially executed for stop limit orders.） `MODIFYING`（Modifying） `CANCELLING`（Cancelling）  *`WAITING`  is valid for stop limit orders.
timeInForce | string | Time in force: `FAK`（Time in force: Fill and kill. When an order can only be partially executed and its remaining part expires.） `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） (`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order)
timestamp | string | Ordered timestamp


<a id="executions"></a>
## Executions

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp  = Date.now().toString();
const method     = 'GET';
const endPoint   = 'https://api.coin.z.com/private';
const path       = '/v1/executions';
const parameters = '?executionId=72123911,92123912';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "executionId": 92123912,
        "orderId": 223456789,
        "clientOrderId": "abc123",
        "positionId": 1234567,
        "symbol": "BTC_JPY",
        "side": "BUY",
        "settleType": "OPEN",
        "size": "0.02",
        "price": "1900000",
        "lossGain": "0",
        "fee": "223",
        "timestamp": "2020-11-24T21:27:04.764Z"
      },
      {
        "executionId": 72123911,
        "orderId": 123456789,
        "positionId": 1234567,
        "symbol": "BTC",
        "side": "BUY",
        "settleType": "OPEN",
        "size": "0.7361",
        "price": "877404",
        "lossGain": "0",
        "fee": "323",
        "timestamp": "2019-03-19T02:15:06.081Z"
      }
    ]
  },
  "responsetime": "2019-03-19T02:15:06.081Z"
}
```

Gets executed order information of the specified order id, execution id or client order id. 
Target: Spot and Margin trading

* Either `orderId` or `executionId` or `clientOrderId` is required. Only one of them can be set at a time.


##### Request
`GET /private/v1/executions`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderId`（Order id） | number | * | Either `orderId` or `executionId`（Execution id） or `clientOrderId`（Client order id） is required.
`executionId`（Execution id） | string | * | Either `orderId`（Order id） or `executionId` or `clientOrderId`（Client order id） is required. A comma-separated list of execution ids. The maximum number of execution ids is 10.
`clientOrderId`（Client order id） | string | * | Either `orderId`（Order id） or `executionId`（Execution id） or `clientOrderId` is required. *Only combinations of up to 36 single-byte alphanumeric characters can be used. *Only one clientOrderId can be specified. A comma-separated list cannot be used.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
executionId | number | Execution id
orderId | number | Order id
clientOrderId | string | Client order id *Returned only when set
positionId | number | Position id *Margin trading only
symbol | string | The handling symbols are [here](#parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
settleType | string | Settlement Type: `OPEN`（Settlement Type: Open position） `CLOSE`（Close postion）
size | string | Executed quantity
price | string | Executed price
lossGain | string | Settlement profit/loss
fee | string | Trade fee *It returns a positive value if Taker, a negative value if Maker.
timestamp | string | Executed timestamp


<a id="latest-executions"></a>
## Latest Executions

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp  = Date.now().toString();
const method     = 'GET';
const endPoint   = 'https://api.coin.z.com/private';
const path       = '/v1/latestExecutions';
const parameters = '?symbol=BTC&page=1&count=100';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "pagination": {
      "currentPage": 1,
      "count": 30
    },
    "list": [
      {
        "executionId": 72123911,
        "orderId": 123456789,
        "clientOrderId": "abc123",
        "positionId": 1234567,
        "symbol": "BTC",
        "side": "BUY",
        "settleType": "OPEN",
        "size": "0.7361",
        "price": "877404",
        "lossGain": "0",
        "fee": "323",
        "timestamp": "2019-03-19T02:15:06.086Z"
      }
    ]
  },
  "responsetime": "2019-03-19T02:15:06.086Z"
}
```

Gets the latest executed order information. 
Target: Spot and Margin trading

* This returns the last day of executed order information.


##### Request
`GET /private/v1/latestExecutions`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)
`page`（Target page） | number | Optional | Target page: If a page is not specified, it will run assuming 1 is set.
`count`（Number of items that you want to get in 1 page） | number | Optional | Number of items that you want to get in 1 page: If a count is not specified, it will run assuming 100 (maximum value) is set.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
executionId | number | Execution id
orderId | number | Order id
clientOrderId | string | Client order id *Returned only when set
positionId | number | Position id *Margin trading only
symbol | string | The handling symbols are [here](#parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
settleType | string | Settlement Type: `OPEN`（Settlement Type: Open position） `CLOSE`（Close postion）
size | string | Executed quantity
price | string | Executed price
lossGain | string | Settlement profit/loss
fee | string | Trade fee *It returns a positive value if Taker, a negative value if Maker.
timestamp | string | Executed timestamp


<a id="open-positions"></a>
## Open Positions

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp  = Date.now().toString();
const method     = 'GET';
const endPoint   = 'https://api.coin.z.com/private';
const path       = '/v1/openPositions';
const parameters = '?symbol=BTC_JPY&page=1&count=100';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "pagination": {
      "currentPage": 1,
      "count": 30
    },
    "list": [
      {
        "positionId": 1234567,
        "symbol": "BTC_JPY",
        "side": "BUY",
        "size": "0.22",
        "orderdSize": "0",
        "price": "876045",
        "lossGain": "14",
        "leverage": "4",
        "losscutPrice": "766540",
        "timestamp": "2019-03-19T02:15:06.094Z"
      }
    ]
  },
  "responsetime": "2019-03-19T02:15:06.095Z"
}
```

Gets a list of opened postions. 
Target: Margin trading


##### Request
`GET /private/v1/openPositions`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling margin symbols are [here](#Margin-parameters-ref)
`page`（Target page） | number | Optional | Target page: If a page is not specified, it will run assuming 1 is set.
`count`（Number of items that you want to get in 1 page） | number | Optional | Number of items that you want to get in 1 page: If a count is not specified, it will run assuming 100 (maximum value) is set.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
positionId | number | Position id
symbol | string | The handling margin symbols are [here](#Margin-parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
size | string | Quantity of the position
orderdSize | string | Quantity of the order
price | string | Price of the position
lossGain | string | Settlement profit/loss
leverage | string | Leverage
losscutPrice | string | Margin Liquidation
timestamp | string | Executed timestamp


<a id="position-summary"></a>
## Position Summary

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp  = Date.now().toString();
const method     = 'GET';
const endPoint   = 'https://api.coin.z.com/private';
const path       = '/v1/positionSummary';
const parameters = '?symbol=BTC_JPY';

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.get(endPoint + path + parameters, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
    "list": [
      {
        "averagePositionRate": "715656",
        "positionLossGain": "250675",
        "side": "BUY",
        "sumOrderQuantity": "2",
        "sumPositionQuantity": "11.6999",
        "symbol": "BTC_JPY"
      }
    ]
  },
  "responsetime": "2019-03-19T02:15:06.102Z"
}
```

Gets a list of the position summary. 
Target: Margin trading

* It is possible to get the position summary by symbol and side (BUY/SELL). If you want to get the position summary of all symbols, we recommend calling out it without a symbol.


##### Request
`GET /private/v1/positionSummary`


##### Parameters
* Parameter type: query

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Optional | If a symbol is not specified, it will return the position summary of all symbols. The handling margin symbols are [here](#Margin-parameters-ref)

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
averagePositionRate | string | Average price of the position
positionLossGain | string | Settlement profit/loss
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
sumOrderQuantity | string | Quantity of the order
sumPositionQuantity | string | Quantity of the position
symbol | string | The handling margin symbols are [here](#Margin-parameters-ref)

<a id="transfer"></a>
## Transfer

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/account/transfer';
const reqBody   = JSON.stringify({
    amount: "100000",
    transferType: "WITHDRAWAL"
})


const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [
    {
      "transferredAmount": "100000"
    }
  ],
  "responsetime": "2019-03-19T02:15:06.055Z"
}
```

Transfer to crypto account or to forex account. 
Maximum 1 transfer requests per 3 minute.


##### Request
`POST /private/v1/account/transfer`


##### Parameters
* Parameter content type: `application/json`

Property Name | Value | Description
--------- | ----------- | -----------
amount | string | Transfer in Japanese yen 
transferType | string | Account transfer type: `WITHDRAWAL`（Account transfer type: WITHDRAWAL (Transfer to forex account)） `DEPOSIT`（DEPOSIT (Transfer to crypto account)）


##### Response

Property Name | Value | Description
--------- | ----------- | -----------
transferredAmount | string | Account transfer amount.

<a id="order"></a>
## Order

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/order';
const reqBody   = JSON.stringify({
    symbol: "BTC_JPY",
    side: "BUY",
    executionType: "LIMIT",
    timeInForce: "FAS",
    price: "430001",
    losscutPrice: "30012",
    size: "0.02"
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};
axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": "637000",
  "responsetime": "2019-03-19T02:15:06.108Z"
}
```

Creates a new order 
Target: Spot and Margin trading

* Spot trade: BUY/SELL order
* Margin trade: Open new BUY/SELL order

##### Request
`POST /private/v1/order`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling symbols are [here](#parameters-ref)
`side`（Side） | string | Required | `BUY`（Buy） `SELL`（Sell）
`executionType`（Execution Type） | string | Required | `MARKET`（Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
`timeInForce`（Time in force） | string | Optional | `FAK`（Fill and kill. When an order can only be partially executed and its remaining part expires.）   `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） ((`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order) `LIMIT`（Execution Type: Limit order） can only be specified  ) *If timeInForce is not specified, FAK for MARKET and STOP, FAS for LIMIT. Please refer to [here](#sok-ref) for symbols for which SOK can be specified.
`price`（Order rate (JPY)） | string | *Depending on executionType | Required if `LIMIT`（Execution Type: Limit order） `STOP`（Stop limit order）. Not required if `MARKET`（Market order）.
`losscutPrice`（Margin Liquidation (JPY)） | string | Optional | Available only when order is margin trading and executionType is `LIMIT`（Execution Type: Limit order） or `STOP`（Stop limit order）.
`size`（Order size） | string | Required 
`clientOrderId`（Client order id） | string | Optional | An order identifier assigned by the client. *Only combinations of up to 36 single-byte alphanumeric characters can be used. *Case-sensitive. *It must be unique within the account, and a clientOrderId that has been used before cannot be reused. The clientOrderId of an order rejected with an error can be reused. *ERR-915 is returned if a clientOrderId that has already been used is specified. When ERR-915 is returned, you can check the result of the original request by calling [Orders](#orders) with the same clientOrderId. *If you use a UUID, specify it as 32 hexadecimal characters with the hyphens removed.
cancelBefore | bool | Optional | `true` Cancellation of active orders and creating new orders will occur at the same time based on the below rule:  If order size > available balance:Existing orders will be cancelled from the oldest, and a new order will execute based on available balance.   If order size ≦ available balance:Old orders will not be cancelled and a new order will be created.  If cancelBefore is not specified, it will run assuming `false` is set.   *You can only specify cancelBefore as `true` for orders which are spot trading, executionType: `MARKET`, timeInforce: `FAK` and side: `SELL`.


##### Response

Property Name | Value | Description
--------- | ----------- | -----------
data | string | The new order's `orderId`（Order id）


<a id="change-order"></a>
## Change Order

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/changeOrder';
const reqBody   = JSON.stringify({
    orderId: 2,
    price: "1201",
    losscutPrice: "1000"
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Changes an order. 
Target: Spot and Margin trading

##### Request
`POST /private/v1/changeOrder`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderId`（Order id） | number | Required | 
`price`（Order rate (JPY)） | string | Required | 
`losscutPrice`（Margin Liquidation (JPY)） | string | Optional | 


<a id="cancel-order"></a>
## Cancel Order

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/cancelOrder';
const reqBody   = JSON.stringify({
    orderId: 2
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Cancels an order 
Target: Spot and Margin trading

##### Request
`POST /private/v1/cancelOrder`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderId`（Order id） | number | Required | 

<a id="cancel-orders"></a>
## Cancel Orders

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/cancelOrders';
const reqBody   = JSON.stringify({
    orderIds: [1,2,3,4]
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": {
      "failed": [
        {
          "message_code": "ERR-5122",
          "message_string": "The request is invalid due to the status of the specified order.",
          "orderId": 1
        },
        {
          "message_code": "ERR-5122",
          "message_string": "The request is invalid due to the status of the specified order.",
          "orderId": 2
        }
      ],
      "success": [3,4]
  },
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Cancels orders 
Target: Spot and Margin trading

* It is possible to cancel max 10 orders

##### Request
`POST /private/v1/cancelOrders`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`orderIds`（Order id） | array | Required | 

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
success | array | Order id that succeeded to accept cancellation
failed | array | Order id that failed to accept cancellation and failure information

<a id="cancel-bulk-order"></a>
## Cancel Bulk Order

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/cancelBulkOrder';
const reqBody   = JSON.stringify({
    symbols: ["BTC","BTC_JPY"],
    side: "BUY",
    settleType: "OPEN",
    desc: true
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": [637000,637002],
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Cancel bulk orders 
Target: Spot and Margin trading

* After searching for cancellation target,Its cancel max 10 orders

##### Request
`POST /private/v1/cancelBulkOrder`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbols`（Ticker Symbol） | array | Required | The handling symbols are [here](#parameters-ref)
`side`（Side） | string | Optional | `BUY`（Buy） `SELL`（Sell） When the parameter is specified, the order of the specified side targets cancellation
`settleType`（Settlement Type） | string | Optional | `OPEN`（Open position） `CLOSE`（Close postion） When the parameter is specified, the spot order and the margin order of the specified settleType targets cancellation
`desc`（Settlement Type） | bool | Optional | `true` The order are cancelled in order from newest by order time `false` The order are cancelled in order from oldest by order time If the desc is not specified, Its value is false

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
data | array | Order id that succeeded to accept cancellation

<a id="close-order"></a>
## Close Order

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/closeOrder';
const reqBody   = JSON.stringify({
    "symbol": "BTC_JPY",
    "side": "BUY",
    "executionType": "LIMIT",
    "timeInForce": "FAS",
    "price": "85201",
    "settlePosition": [
        {
            "positionId": 1000342,
            "size": "3.44"
        }
    ]
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": "637000",
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Closes a position 
Target: Margin trading

##### Request
`POST /private/v1/closeOrder`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling margin symbols are [here](#Margin-parameters-ref)
`side`（Side） | string | Required | `BUY`（Buy） `SELL`（Sell）
`executionType`（Execution Type） | string | Required | `MARKET`（Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
`timeInForce`（Time in force） | string | Optional | `FAK`（Fill and kill. When an order can only be partially executed and its remaining part expires.）   `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） ((`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order) `LIMIT`（Execution Type: Limit order） can only be specified  ) *If timeInForce is not specified, FAK for MARKET and STOP, FAS for LIMIT. Please refer to [here](#sok-ref) for symbols for which SOK can be specified.
`price`（Order rate (JPY)） | string | *Depending on executionType | Required if `LIMIT`（Execution Type: Limit order） `STOP`（Stop limit order）. Not required if `MARKET`（Market order）.
`settlePosition.positionId`（Position id） | number | Required | Allowed to set one position.
`settlePosition.size`（Quantity of the order） | string | Required | Allowed to set one position.
`clientOrderId`（Client order id） | string | Optional | An order identifier assigned by the client. *Only combinations of up to 36 single-byte alphanumeric characters can be used. *Case-sensitive. *It must be unique within the account, and a clientOrderId that has been used before cannot be reused. The clientOrderId of an order rejected with an error can be reused. *ERR-915 is returned if a clientOrderId that has already been used is specified. When ERR-915 is returned, you can check the result of the original request by calling [Orders](#orders) with the same clientOrderId. *If you use a UUID, specify it as 32 hexadecimal characters with the hyphens removed.
cancelBefore | bool | Optional | `true` Cancellation of active orders and creating new orders will occur at the same time based on the below rule:  If order size > available balance:Existing orders will be cancelled from the oldest, and a new order will execute based on available balance.   If order size ≦ available balance:Old orders will not be cancelled and a new order will be created.  If cancelBefore is not specified, it will run assuming `false` is set.   *You can only specify cancelBefore as `true` for orders which are executionType: `MARKET`, timeInforce: `FAK` and side: `SELL`. *cancelBefore cannot be set for active orders associated with multiple positions

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
data | string | The new closing order's `orderId`（Order id）


<a id="close-bulk-order"></a>
## Close Bulk Order

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/closeBulkOrder';
const reqBody   = JSON.stringify({
    "symbol": "BTC_JPY",
    "side": "BUY",
    "executionType": "LIMIT",
    "timeInForce": "FAS",
    "price": "85201",
    "size": "3.44"
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": "637000",
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Closes bulk orders. 
Target: Margin trading

##### Request
`POST /private/v1/closeBulkOrder`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`symbol`（Ticker Symbol） | string | Required | The handling margin symbols are [here](#Margin-parameters-ref)
`side`（Side） | string | Required | `BUY`（Buy） `SELL`（Sell）
`executionType`（Execution Type） | string | Required | `MARKET`（Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
`timeInForce`（Time in force） | string | Optional | `FAK`（Fill and kill. When an order can only be partially executed and its remaining part expires.）   `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） ((`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order) `LIMIT`（Execution Type: Limit order） can only be specified  ) *If timeInForce is not specified, FAK for MARKET and STOP, FAS for LIMIT. Please refer to [here](#sok-ref) for symbols for which SOK can be specified.
`price`（Order rate (JPY)） | string | *Depending on executionType | Required if `LIMIT`（Execution Type: Limit order） `STOP`（Stop limit order）. Not required if `MARKET`（Market order）.
`size`（Quantity of the order） | string | Required | 
`clientOrderId`（Client order id） | string | Optional | An order identifier assigned by the client. *Only combinations of up to 36 single-byte alphanumeric characters can be used. *Case-sensitive. *It must be unique within the account, and a clientOrderId that has been used before cannot be reused. The clientOrderId of an order rejected with an error can be reused. *ERR-915 is returned if a clientOrderId that has already been used is specified. When ERR-915 is returned, you can check the result of the original request by calling [Orders](#orders) with the same clientOrderId. *If you use a UUID, specify it as 32 hexadecimal characters with the hyphens removed.

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
data | string | The new closing bulk order's `orderId`（Order id）


<a id="change-losscut-price"></a>
## Change Margin Liquidation

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/changeLosscutPrice';
const reqBody   = JSON.stringify({
    "positionId": 305885,
    "losscutPrice": "750000"
})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "responsetime": "2019-03-19T01:07:24.557Z"
}
```

Changes the margin liquidation of the specified position. 
Target: Margin trading

##### Request
`POST /private/v1/changeLosscutPrice`

##### Parameters
* Parameter content type: `application/json`

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
`positionId`（Position id） | number | Required | 
`losscutPrice`（Margin Liquidation (JPY)） | string | Required | 


<a id="private-ws-api"></a>
# Private WebSocket API

* A ping will be sent from the server to a client once per minute. If there's no response (pong) from a client 3 consecutive times, then the WebSocket will be disconnected automatically.
* Using a [Private API](#ws-auth-post) for authentication in order to obtain, extend and remove the access token.
* A Private WebSocket API's URL will be `Endpoint of Private WebSocket API + Access token` e.g. `wss://api.coin.z.com/ws/private/v1/xxxxxxxxxxxxxxxxxxxx`

<a id="ws-auth-post"></a>
## Create Access Token

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'POST';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/ws-auth';
const reqBody   = JSON.stringify({})

const text = timestamp + method + path + reqBody;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};

axios.post(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "data": "xxxxxxxxxxxxxxxxxxxx",
  "responsetime": "2019-03-19T02:15:06.102Z"
}
```

Gets an access token to call Private WebSocket API.

* The expiration time of access token is 60 minutes.
* The maximum number of access tokens is 5.
* If the number of issued tokens exceeds the maximum number of tokens, the tokens will be deleted in order of expiration time.
* To use the API with the existing API keys, open your membership site > API > 編集 (Edit) > APIキーの編集 (API key setting) screen and click "約定情報通知(WebSocket)" (Execution Notifications), "注文情報通知(WebSocket)" (Order Notifications), "ポジション情報通知(WebSocket)" (Position Notifications) or "ポジションサマリー情報通知(WebSocket)" (Position Summary Notifications) to call the Create Access Token API.

*Please set the API key permission before obtaining the access token.


##### Request
`POST /private/v1/ws-auth`


##### Parameters
None

##### Response

Property Name | Value | Description
--------- | ----------- | -----------
data | string | Access token


<a id="ws-auth-put"></a>
## Extend Access Token

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'PUT';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/ws-auth';
const reqBody   = JSON.stringify({
    "token": "xxxxxxxxxxxxxxxxxxxx"
})

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    }
};


axios.put(endPoint + path, reqBody, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "responsetime": "2019-03-19T02:15:06.102Z"
}
```

Extends the expiration time of an access token.

* The new expiration time is 60 minutes.


##### Request
`PUT /private/v1/ws-auth`


##### Parameters
* Parameter type: JSON

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
token | string | Required | Access token


<a id="ws-auth-delete"></a>
## Delete Access Token

> Request example:

```javascript
const axios  = require('axios');
const crypto = require('crypto');

const apiKey    = 'YOUR_API_KEY';
const secretKey = 'YOUR_SECRET_KEY';

const timestamp = Date.now().toString();
const method    = 'DELETE';
const endPoint  = 'https://api.coin.z.com/private';
const path      = '/v1/ws-auth';
const reqBody   = JSON.stringify({
    "token": "xxxxxxxxxxxxxxxxxxxx"
})

const text = timestamp + method + path;
const sign = crypto.createHmac('sha256', secretKey).update(text).digest('hex');
const options = {
    "headers": {
        "API-KEY": apiKey,
        "API-TIMESTAMP": timestamp,
        "API-SIGN": sign
    },
    "data": reqBody,
};


axios.delete(endPoint + path, options)
  .then(function (response) {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(function (error) {
    console.log(error);
  });
```

> Response example:

```json
{
  "status": 0,
  "responsetime": "2019-03-19T02:15:06.102Z"
}
```

Deletes an access token.


##### Request
`DELETE /private/v1/ws-auth`


##### Parameters
* Parameter type: JSON

Parameter | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
token | string | Required | Access token


<a id="ws-execution-events"></a>
## Execution Notifications

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/private/v1/xxxxxxxxxxxxxxxxxxxx");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "executionEvents"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel": "executionEvents",
  "orderId": 123456789,
  "clientOrderId": "abc123",
  "executionId": 72123911,
  "symbol": "BTC_JPY",
  "settleType": "OPEN",
  "executionType": "LIMIT",
  "side": "BUY",
  "executionPrice": "877404",
  "executionSize": "0.5",
  "positionId": 123456789,
  "orderTimestamp": "2019-03-19T02:15:06.081Z",
  "executionTimestamp": "2019-03-19T02:15:06.081Z",
  "lossGain": "0",
  "fee": "323",
  "orderPrice": "877200",
  "orderSize": "0.8",
  "orderExecutedSize": "0.7",
  "timeInForce": "FAS",
  "msgType": "ER"
}
```

Receives latest execution events notifications. 
After `subscribe`（WebSocket Command: Start subscribing）, latest execution events notification will be sent.


##### Parameters
* Parameter type: JSON

Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `executionEvents`（Channel Name: Execution Notifications）


##### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `executionEvents`（Channel Name: Execution Notifications）
orderId | number | Order id
clientOrderId | string | Client order id *Returned only when set
executionId | number | Execution id
symbol | string | The handling symbols are [here](#parameters-ref)
settleType | string | Settlement Type: `OPEN`（Settlement Type: Open position） `CLOSE`（Close postion）
executionType | string | Execution Type: `MARKET`（Execution Type: Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
executionPrice | string | Executed price
executionSize | string | Executed quantity
positionId | number | Position id *Margin trading only
orderTimestamp | string | Ordered timestamp
executionTimestamp | string | Executed timestamp
lossGain | string | Settlement profit/loss
fee | string | Trade fee *It returns a positive value if Taker, a negative value if Maker.
orderPrice | string | Price of the order (This property is not included if the order is `MARKET`（Execution Type: Market order）.)
orderSize | string | Ordered size
orderExecutedSize | string | Excecuted size of the order
timeInForce | string | Time in force: `FAK`（Time in force: Fill and kill. When an order can only be partially executed and its remaining part expires.） `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） (`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order)
msgType | string | Message Type: `ER`（Message Type: Executed）

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.


<a id="ws-order-events"></a>
## Order Notifications

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/private/v1/xxxxxxxxxxxxxxxxxxxx");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "orderEvents"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel": "orderEvents",
  "orderId": 123456789,
  "clientOrderId": "abc123",
  "symbol": "BTC_JPY",
  "settleType": "OPEN",
  "executionType": "LIMIT",
  "side": "BUY",
  "orderStatus": "CANCELED",
  "cancelType": "USER",
  "orderTimestamp": "2019-03-19T02:15:06.081Z",
  "orderPrice": "876045",
  "orderSize": "0.8",
  "orderExecutedSize": "0",
  "losscutPrice": "0",
  "timeInForce": "FAS",
  "msgType": "NOR"
}
```

Receives latest order events notifications. 
After `subscribe`（WebSocket Command: Start subscribing）, latest order events notification will be sent.


##### Parameters
* Parameter type: JSON

Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `orderEvents`（Channel Name: Order Notifications）


##### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `orderEvents`（Channel Name: Order Notifications）
orderId | number | Order id
clientOrderId | string | Client order id *Returned only when set
symbol | string | The handling symbols are [here](#parameters-ref)
settleType | string | Settlement Type: `OPEN`（Settlement Type: Open position） `CLOSE`（Close postion） `LOSS_CUT`（Margin liquidation）
executionType | string | Execution Type: `MARKET`（Execution Type: Market order） `LIMIT`（Limit order） `STOP`（Stop limit order）
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
orderStatus | string | Order Status: `WAITING`（Order Status: Waiting *Valid for stop limit orders.） `ORDERED`（Valid or partially executed *Partially executed for stop limit orders.） `CANCELED`（Canceled） `EXPIRED`（Expired）  *`WAITING`  is valid for stop limit orders.
cancelType | string | Cancel Type: `USER`（Cancel Type: Canceled by the user.） `POSITION_LOSSCUT`（Canceled the margin trading order due to the position loss-cut.） `INSUFFICIENT_BALANCE`（Canceled the order due to the insufficient available amount. (Spot trading)） `INSUFFICIENT_MARGIN`（Canceled the order due to the insufficient available amount. (Margin trading)） `ACCOUNT_LOSSCUT`（Canceled the margin trading order because of insufficient balance in your account due to loss-cut.） `MARGIN_CALL`（Order canceled due to a margin call.） `MARGIN_CALL_LOSSCUT`（Settlement order canceled due to a losscut from a margin call.） `EXPIRED_FAK`（Expired by FAK） `EXPIRED_FOK`（Expired by FOK） `EXPIRED_SOK`（Expired by SOK） `EXPIRED_SELFTRADE`（Expired due to Self-trade.） `COLLATERAL_LIQUIDATION`（Order canceled due to collateral crypto-asset liquidation） `CLOSED_ORDER`（Failed to change order due to closed order）  *It is returned if orderStatus is `CANCELED` or `EXPIRED`.  Cancel Type: `SOK_TAKER`（Failed to change order due to taker） `PRICE_LIMIT`（Failed to change order due to price limit）  *It is returned if orderStatus is `ORDERED`.   
orderTimestamp | string | Ordered timestamp
orderPrice | string | Price of the order (This property is not included if the order is `MARKET`（Execution Type: Market order）.)
orderSize | string | Ordered size
orderExecutedSize | string | Excecuted size of the order
losscutPrice | string | Margin Liquidation (It should be "0" if the order is Spot trading or losscutPrice is not set.)
timeInForce | string | Time in force: `FAK`（Time in force: Fill and kill. When an order can only be partially executed and its remaining part expires.） `FAS`（Fill and store. When an order can only be partially executed and its remaining part is still valid.） `FOK`（Fill or kill. If an order is not executed immediately, the order will expire.） (`SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)） is Post-only order)
msgType | string | Message Type: `NOR`（Message Type: New Order Response） `ROR`（Replace Order Response） `COR`（Cancel Order Response） `ER`（Expired）

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.


<a id="ws-position-events"></a>
## Position Notifications

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/private/v1/xxxxxxxxxxxxxxxxxxxx");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "positionEvents"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel": "positionEvents",
  "positionId": 1234567,
  "symbol": "BTC_JPY",
  "side": "BUY",
  "size": "0.22",
  "orderdSize": "0",
  "price": "876045",
  "lossGain": "14",
  "leverage": "4",
  "losscutPrice": "766540",
  "timestamp": "2019-03-19T02:15:06.094Z",
  "msgType": "OPR"
}
```

Receives latest position events notifications. 
After `subscribe`（WebSocket Command: Start subscribing）, latest position events notification will be sent.


##### Parameters
* Parameter type: JSON

Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `positionEvents`（Channel Name: Position Notifications）


##### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `positionEvents`（Channel Name: Position Notifications）
positionId | number | Position id
symbol | string | The handling margin symbols are [here](#Margin-parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
size | string | Quantity of the position
orderdSize | string | Quantity of the order
price | string | Price of the position
lossGain | string | Settlement profit/loss
leverage | string | Leverage
losscutPrice | string | Margin Liquidation
timestamp | string | Executed timestamp
msgType | string | Message Type: `OPR`（Message Type: Opened Position） `UPR`（Partially Executed Position） `ULR`（Changed Margin Liquidation） `CPR`（Closed Position）

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.


<a id="ws-position-summary-events"></a>
## Position Summary Notifications

> Request example:

```javascript
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/private/v1/xxxxxxxxxxxxxxxxxxxx");

ws.on("open", () => {
    const message = JSON.stringify(
    {
        "command": "subscribe",
        "channel": "positionSummaryEvents"
    });
    ws.send(message);
});

ws.on("message", (data) => {
    console.log("WebSocket message: ", data);
});
```

> Response example:

```json
{
  "channel":"positionSummaryEvents",
  "symbol":"BTC_JPY",
  "side":"BUY",
  "averagePositionRate":"1014484",
  "positionLossGain":"18",
  "sumOrderQuantity":"0.01",
  "sumPositionQuantity":"0.03",
  "timestamp":"2020-06-24T09:53:19.702Z",
  "msgType":"UPDATE"
}
```

Receives latest position summary events notifications. 
After `subscribe`（WebSocket Command: Start subscribing）, latest position summary events notification will be sent.


##### Parameters
* Parameter type: JSON

Property Name | Type | Required | Available Values
--------- | ----------- | ----------- | -----------
command | string | Required | `subscribe`（WebSocket Command: Start subscribing） `unsubscribe`（Stop subscribing）
channel | string | Required | `positionSummaryEvents`（Channel Name: Position Summary Notifications）
option | string | Optional | `PERIODIC`（Option: Send periodic data.） *If option is specified, it will send data every 5 seconds. *If you request multiple subscriptions, only the latest request will be valid.


#### Response

Property Name | Value | Description
--------- | ----------- | -----------
channel | string | `positionSummaryEvents`（Channel Name: Position Summary Notifications）
symbol | string | The handling margin symbols are [here](#Margin-parameters-ref)
side | string | Side: `BUY`（Side: Buy） `SELL`（Sell）
averagePositionRate | string | Average price of the position
positionLossGain | string | Settlement profit/loss
sumOrderQuantity | string | Quantity of the order
sumPositionQuantity | string | Quantity of the position
timestamp | string | Timestamp of the notifications
msgType | string | Message Type: `INIT`（Message Type: Initial data） `UPDATE`（Updated data） `PERIODIC`（Periodic data）

* There is no Response when `unsubscribe`（WebSocket Command: Stop subscribing） is requested.


<a id="historical_data"></a>
# Historical Data
You can download the historical data (.CSV file) [here](https://api.coin.z.com/data/trades/).


<a id="references"></a>
# References

This section explains about codes, which are API parameters and response values.

<a id="parameters-ref"></a>
## Parameters

This section explains about parameters and their details.

###  
symbol: Trading symbol

Value | Description | Release date
----- | ----- | -----
BTC | Bitcoin (Spot trading) | 2018/09/05
ETH | Ethereum (Spot trading) | 2019/01/30
BCH | BitcoinCash (Spot trading) | 2019/01/30
LTC | Litecoin (Spot trading) | 2019/01/30
XRP | Ripple (Spot trading) | 2019/01/30
XLM | Stellar (Spot trading) | 2021/08/18
DOT | Polkadot (Spot trading) | 2022/06/08
ATOM | Cosmos (Spot trading) | 2022/06/08
FCR     | FCR Coin (Spot trading)     | 2022/05/18
ADA | Cardano (Spot trading) | 2022/07/13
LINK | Chainlink (Spot trading) | 2022/07/13
DOGE | Dogecoin (Spot trading) | 2023/08/05
SOL | Solana (Spot trading) | 2023/08/05
ASTR | Astar (Spot trading) | 2023/03/22
NAC | NOT A HOTEL COIN (Spot trading) | 2024/12/13
SUI | Sui (Spot trading) | 2026/01/17
WILD | Wilder World (Spot trading) | 2026/03/21
MNT | Mantle (Spot trading) | 2026/10/31
BNB | Build and Build (Spot trading) | 2026/10/31

<a id="Margin-parameters-ref"></a>
###  

Value | Description | Release date
----- | ----- | -----
BTC_JPY | Bitcoin-Japanese Yen (Margin trading) | 2018/09/05
ETH_JPY | Ethereum-Japanese Yen (Margin trading) | 2019/01/30
BCH_JPY | BitcoinCash-Japanese Yen (Margin trading) | 2019/01/30
LTC_JPY | Litecoin-Japanese Yen (Margin trading) | 2019/01/30
XRP_JPY | Ripple-Japanese Yen (Margin trading) | 2019/01/30
DOT_JPY | Polkadot-Japanese Yen (Margin trading) | 2024/04/13
ATOM_JPY | Cosmos-Japanese Yen (Margin trading) | 2024/04/13
ADA_JPY | Cardano-Japanese Yen (Margin trading) | 2024/04/13
LINK_JPY | Chainlink-Japanese Yen (Margin trading) | 2024/04/13
DOGE_JPY | Dogecoin-Japanese Yen (Margin trading) | 2024/04/13
SOL_JPY | Solana-Japanese Yen (Margin trading) | 2024/04/13
SUI_JPY | Sui-Japanese Yen (Margin trading) | 2026/01/17
MNT_JPY | Mantle-Japanese Yen (Margin trading) | 2026/10/31
BNB_JPY | Build and Build-Japanese Yen (Margin trading) | 2026/10/31

<a id="Asset-parameters-ref"></a>
###  
symbol: Asset Ticker Symbol

Value | Description 
----- | ----- | -----
JPY | Japanese Yen 
BTC | Bitcoin (OTC Spot) 
ETH | Ethereum (OTC Spot) 
BCH | BitcoinCash (OTC Spot) 
LTC | Litecoin (OTC Spot) 
XRP | Ripple (OTC Spot) 
XLM | Stellar Lumens (OTC Spot) 
OMG | OMG 
DOT | Polkadot (OTC Spot) 
ATOM | Cosmos (OTC Spot) 
FCR     | FCR Coin (Exchange)     
ADA | Cardano (OTC Spot) 
LINK | Chainlink (OTC Spot) 
DOGE | Dogecoin (OTC Spot)
SOL | Solana (OTC Spot)
ASTR | Astar (Exchange)
NAC     | NOT A HOTEL COIN (Exchange)
AVAX | AVAX (OTC Spot)
WILD | Wilder World (Exchange)
SUI | Sui (OTC Spot)
ZPG | ZPG (OTC Spot)
ZPGAG | ZPGAG (OTC Spot)
ZPGPT | ZPGPT (OTC Spot)
MNT | Mantle (OTC Spot)
BNB | Build and Build (OTC Spot)

#### side: Side

Value | Description
----- | -----
BUY | Buy
SELL | Sell

#### executionType: Execution Type

Value | Description
----- | -----
MARKET | Market order
LIMIT  | Limit order
STOP  | Stop limit order

#### timeInForce: Time in force

Value | Description
----- | -----
FAK | Fill and kill. When an order can only be partially executed and its remaining part expires.
FAS | Fill and store. When an order can only be partially executed and its remaining part is still valid.
FOK | Fill or kill. If an order is not executed immediately, the order will expire.
SOK | Store or kill. If a limit order is not maker, the order will expire. (Post-only order)

<a id="sok-ref"></a>
## Symbols for which SOK(Post-Only) can be specified in the timeInForce parameter
Service | Description     
----- |-----------
Spot Trading | All symbols can be specified       
Margin Trading | All symbols can be specified

<a id="http-status-code"></a>
## HTTP Status Codes
Status Code | Description
------------- | -----
200 | A response for successful HTTP requests.
404 | `A response for when requested URL is invalid.`（e.g. There is an incorrect part in a URL at private/public part such as 'https://api.coin.z.com/publlic/v1/status'.）
503 | A response code that when WebSocket API is called while the service is in maintenance.

<a id="status-code"></a>
## Status Codes

Status Code | Description
------------| -----------------------------
0           | A response for successful API processing.

<a id="error-code"></a>
## Error Codes

Error Code | Description
---------- | -----
ERR-70   | It will be returned when the BUY/SELL side of the specified position is incorrect in the settlement order.
ERR-189  | The quantity of your close order exceeds your open position.
ERR-200  | There are existing active orders and your order exceeds the maximum quantity that can be ordered. Please change the quantity to order or [cancel an active order](#cancel-order) in order to create a new [close order](#close-order).
ERR-201  | Insufficient funds.
ERR-208  | The quantity of your order exceeds your available balance. Please check your balance or active orders. Also returned by CryptoCurrency withdrawal when the sendAmount plus the fee exceeds your balance of the symbol.
ERR-254  | The specified position does not exist.
ERR-422  | It will be returned when the specified position does not exist in the close bulk order. Please make sure that the symbol or side (BUY/SELL) is correct.
ERR-423  | It will be returned when the order quantity exceeds the total quantity of the positions that can be closed in the close bulk order.
ERR-430  | Invalid parameter (orderId/executionId) in executions.
ERR-554  | The server is unavailable.
ERR-626  | The server is busy. Please retry later.
ERR-635  | The number of active orders has exceeded the limit. Please [cancel an active order](#cancel-order) to create a new [order](#order).
ERR-682  | A margin call has occurred. The operation cannot be executed.
ERR-683  | Margin call processing is in progress. The operation cannot be executed.
ERR-754  | Not enough transferable amount to transfer.
ERR-846  | The difference between fromTimestamp and toTimestamp is greater than the maximum of 30 minutes.
ERR-913  | Sell the entire collateral quantity, or sell so that the remaining collateral quantity after the sale is at least the minimum collateral quantity.
ERR-915  | Invalid clientOrderId in order (already used).
ERR-5003 | The API usage limits are exceeded.
ERR-5004 | An unexpected response was received from backend server. Execution status unknown. The request may have been accepted, so check the result by calling [CryptoCurrency withdrawal status](#withdrawalStatus) with clientOrderId (or with orderId for a cancellation request). Check the result in the same way when the response times out.
ERR-5007 | The API-TIMESTAMP is not set in the request header, or the value of API-TIMESTAMP is not a numeric value. Please ensure that the API-TIMESTAMP is set in the request header, and that the value is a numeric representation of a UNIX timestamp in milliseconds.
ERR-5008 | The API-TIMESTAMP set in the request header is later than the system time of the API. Please try updating the system time.
ERR-5009 | The API-TIMESTAMP set in the request header is earlier than the system time of the API. Please try updating the system time.
ERR-5010 | The API-SIGN (Signature) is invalid. Please check [Authentication](#authentication).
ERR-5011 | The API-KEY is empty. Please check [Authentication](#authentication).
ERR-5012 | The API authentication is invalid.
ERR-5014 | The membership agreement has not been completed.
ERR-5016 | The history query timed out. Please retry, or narrow the date range.
ERR-5106 | The request parameter is invalid.
ERR-5111 | Invalid timeInForce values. Please see the possible timeInForce values in [Order](#order), [Close Order](#close-order) and [Close Bulk Order](#close-bulk-order).
ERR-5114 | The number of decimals exceeds the maximum precision. Please check the minimum order value [here](https://coin.z.com/jp/corp/product/info/exchange/#ank-02).
ERR-5118 | Returned when LosscutPrice cannot be specified in the request body.
ERR-5121 | Impossible to order due to order price is too low.
ERR-5122 | The specified order can not be changed or canceled (already MODIFYING, CANCELLING, CANCELED, EXECUTED or EXPIRED). Orders can be changed or canceled only in ORDERED (WAITING for stop limit orders) status.
ERR-5123 | The specified order doesn't exist.
ERR-5125 | Returned when there is API restriction.
ERR-5126 | The amount exceeds the maximum order amount or is less than the minimum order amount. Please check the trading rules [here](https://coin.z.com/jp/corp/product/info/exchange/#ank-02).
ERR-5127 | Your API connection is restricted.
ERR-5129 | Stop limit orders cannot be specified a price that will be executed immediately.
ERR-5130 | The orderID(s) exceeds the number that can be specified.
ERR-5132 | The executionID(s) exceeds the number that can be specified.
ERR-5133 | Account transfers are not possible due to transfer restrictions.
ERR-5135 | FxAccount not opened. Please try again ofter opening FxAccount.
ERR-5138 | The withdrawal address is invalid.
ERR-5139 | The withdrawal address is not yet available.
ERR-5140 | The deposit address has not been issued.
ERR-5141 | Withdrawal is restricted within one month of account opening.
ERR-5142 | Failed to get the rate.
ERR-5144 | The withdrawal cannot be canceled.
ERR-5145 | The clientOrderID(s) exceeds the number that can be specified.
ERR-5146 | Withdrawal of this symbol is suspended.
ERR-5147 | Customer information is not registered.
ERR-5148 | This operation is restricted because the identification document has expired.
ERR-5149 | This account cannot use the withdrawal service.
ERR-5150 | Withdrawal is limited by a recent Pay-easy deposit.
ERR-5151 | This account is currently under trade restrictions.
ERR-5152 | The destination account is closed.
ERR-5153 | The purpose of the withdrawal is invalid.
ERR-5154 | The location in tradeDetails (a nonexistent country or region code, an invalid combination of regionCode and cityName, or a missing location) or itemName is invalid. A country or region to which we do not allow withdrawals does not return ERR-5154; after acceptance, the request is rejected (REJECTED) in the review of the withdrawal purpose.
ERR-5155 | Returned when sendAmount in a CryptoCurrency withdrawal request to an external address is below the minimum withdrawal amount. The minimum withdrawal amount does not apply to withdrawals to a GMO Coin account (internal withdrawal). ERR-5155 is not returned when you specify your entire holding for a symbol other than DOT; ERR-208 is returned instead because the balance does not cover the fee.
ERR-5156 | This internal withdrawal requires a review and cannot be accepted.
ERR-5157 | Exceeds the daily withdrawal limit.
ERR-5158 | The specified withdrawal was not found.
ERR-5201 | A response code that when Public/Private API is called while the service is in a regular maintenance. CryptoCurrency withdrawal APIs are accepted while the Service Status is MAINTENANCE; they are not accepted, and this error is returned, only during the regular maintenance of the whole service.
ERR-5202 | A response code that when Public/Private API is called while the service is in a emergency maintenance.
ERR-5203 | A response code that when order or change order is called while the service is pre-open. * CryptoCurrency withdrawal APIs (CryptoCurrency withdrawal, Cancel CryptoCurrency withdrawal, CryptoCurrency withdrawal status, Registered withdrawal addresses, Withdrawal purposes, Countries and regions, and States and provinces) are accepted and this error is not returned while the [Service Status](#status) is PREOPEN or MAINTENANCE (during the regular maintenance of the whole service they are not accepted and ERR-5201 is returned).
ERR-5204 | `The request API PATH is invalid.`（e.g. The request URL after the private/public part is invalid such as 'https://api.coin.z.com/public/public/v1/status'.）
ERR-5206 | The limits of changing order for each order are exceeded. If you would like further changes for the order, please [cancel the order](#cancel-order) and create a brand new [order](#order).
ERR-5207 | Invalid symbol, interval or date values.
ERR-5208 | OrderId(s) and executionId(s) cannot be used at the same time.
ERR-5212 | OrderId and ClientOrderId cannot be used at the same time.
ERR-5230 | ExecutionId and ClientOrderId cannot be used at the same time.

<a id="feedback"></a>
# Feedback
We'd like to hear some feedback about our API. Your feedback will be carefully reviewed by our development team, to be developed and released sequentially. Please click [here](https://support.coin.z.com/hc/ja/requests/new?ticket_form_id=360002450434) to contact us about any requests you may have about the API.

*Please click [here](https://support.coin.z.com/hc/ja/requests/new) to contact us about API inquiries. We may take some time to respond depending on the inquiry. Thank you for your understanding.


<a id="changelogs"></a>
# Changelog

## 2026

###   2026-11-14 New

[Registered withdrawal addresses](#withdrawalAddresses) has been released
[Withdrawal purposes](#withdrawalPurposes) has been released
[Countries and regions](#withdrawalNations) has been released
[States and provinces](#withdrawalProvinces) has been released
[CryptoCurrency withdrawal](#withdrawal) has been released
[CryptoCurrency withdrawal status](#withdrawalStatus) has been released
[Cancel CryptoCurrency withdrawal](#cancelWithdrawal) has been released

[API Limiting](#restrictions)

* **Added that each CryptoCurrency withdrawal API can be called only with an API key that has the permission for that API.**

[Creating API Keys](#api-key)

* **Added the permissions for the CryptoCurrency withdrawal APIs and notes on API keys with those permissions.**

[Error Codes](#error-code)

* **Added new error codes: ERR-5004, ERR-5138 to ERR-5142, ERR-5144 and ERR-5146 to ERR-5158**
* **ERR-208 and ERR-915 are now also returned by CryptoCurrency withdrawal, ERR-5003 is now also returned when CryptoCurrency withdrawal requests for the same symbol exceed once per second, and ERR-5212 is now also returned by CryptoCurrency withdrawal status.**
* **ERR-5201 and ERR-5203 now note that the CryptoCurrency withdrawal APIs are accepted while the Service Status is PREOPEN or MAINTENANCE.**

###   2026-11-07

[Assets](#assets)

* **Removed the `symbol`（Ticker Symbol）: **`FIL`（Filecoin (OTC Spot)） `SAND`（The Sandbox (OTC Spot)） `CHZ`（Chiliz (OTC Spot)）** from the Response section.**

###   2026-10-31

Added: Mantle (Spot trading and Margin trading), Build and Build (Spot trading and Margin trading)

* **Added a new `symbol`（Ticker Symbol）: **`MNT`（Mantle (Spot trading)） `MNT_JPY`（Mantle-Japanese Yen (Margin trading)） `BNB`（Build and Build (Spot trading)） `BNB_JPY`（Build and Build-Japanese Yen (Margin trading)）** to the Parameter and Response section.**

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`MNT`（Mantle (Spot trading)） `BNB`（Build and Build (Spot trading)）** to the Response section.**

###   2026-10-10

[Order](#order)

* **Added a new request parameter: clientOrderId**

[Close Order](#close-order)

* **Added a new request parameter: clientOrderId**

[Close Bulk Order](#close-bulk-order)

* **Added a new request parameter: clientOrderId**

[Orders](#orders)

* **Added a new request parameter and response property: clientOrderId**

[Executions](#executions)

* **Added a new request parameter and response property: clientOrderId**

[Active Orders](#active-orders)

* **Added a new response property: clientOrderId**

[Latest Executions](#latest-executions)

* **Added a new response property: clientOrderId**

[Execution Notifications](#ws-execution-events)

* **Added a new response property: clientOrderId**

[Order Notifications](#ws-order-events)

* **Added a new response property: clientOrderId**

[Error Codes](#error-code)

* **Added new error codes: ERR-915, ERR-5130, ERR-5132, ERR-5145, ERR-5212 and ERR-5230**

###   2026-10-03

[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Tier 3 (last week trading volume of 2 billion or more, 50 GET and 50 POST requests per second) has been added, and the trading volume requirements for Tier 2 have been changed to 1 billion or more and under 2 billion. 

###   2026-08-29

[Exchange Fee History](#exchangeFeeHistory) has been released

###   2026-07-25

[Orders](#orders)

* **Added a new `cancelType`（Cancel Type）: **`COLLATERAL_LIQUIDATION`（Order canceled due to collateral crypto-asset liquidation）** to the Response section.**

[Order Notifications](#ws-order-events)

* **Added a new `cancelType`（Cancel Type）: **`COLLATERAL_LIQUIDATION`（Order canceled due to collateral crypto-asset liquidation）** to the Response section.**

[Margin](#margin)

* **Clarified that availableAmount is the trading capacity for leverage trading, including the collateral crypto-asset value.**
* **Added a new response property: availableAmountForSpot**
* **Added a new response property: cryptoShortfallStatus**

[Error Codes](#error-code)

* **Added a new error code: ERR-913**

[Assets](#assets)

* **Removed the `symbol`（Ticker Symbol）: **`XTZ`（Tezos (Spot trading)） `FLR`（FLARE）** from the Response section.**

###   2026-07-18

[The handling symbols](#parameters-ref)

* **Removed the `symbol`（Ticker Symbol）: **`XTZ`（Tezos (Spot trading)）** from the Parameter and Response section. **

###   2026-06-27

[Assets](#assets)

* **Removed the `symbol`（Ticker Symbol）: **`DAI`（Dai (Spot trading)）** from the Response section.**

###   2026-06-06

[The handling symbols](#parameters-ref)

* **Removed the `symbol`（Ticker Symbol）: **`DAI`（Dai (Spot trading)）** from the Parameter and Response section. **

###   2026-04-18

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`ZPG`（ZPG(OTC Spot)） `ZPGAG`（ZPGAG(OTC Spot)） `ZPGPT`（ZPGPT(OTC Spot)） ** to the Response section.**

###   2026-03-21

Added: Wilder World (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`WILD`（Wilder World (Spot trading)） ** to the Parameter and Response section.**

[Assets](#assets)

- **Added a new `symbol`（Ticker Symbol）: **`WILD`（Wilder World (Exchange)）** to the Response section.**

###   2026-01-17

Added: Sui (Spot trading and Margin trading)

* **Added a new `symbol`（Ticker Symbol）: **`SUI`（Sui (Spot trading)） `SUI_JPY`（Sui-Japanese Yen (Margin trading)）** to the Parameter and Response section.**

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`SUI`（Sui (Spot trading)）** to the Response section.**

All symbols in Spot Trading and Margin Trading can now specify SOK(Post-Only) in the timeInForce parameter.

## 2025

###   2025-10-25

[Assets](#assets)

* **Removed the `symbol`（Ticker Symbol）: **`MKR`（Maker (Spot trading)）** from the Response section.**

###   2025-10-04

[The handling symbols](#parameters-ref)

* **Removed the `symbol`（Ticker Symbol）: **`MKR`（Maker (Spot trading)）** from the Parameter and Response section. **

###   2025-08-02

[Assets](#assets)

* **Removed the `symbol`（Ticker Symbol）: **`XEM`（NEM (Spot trading)） `BAT`（Basic Attention Token (Spot trading)） `QTUM`（Qtum (Spot trading)） `ENJ`（Enjin Coin (Spot trading)） `XYM`（Symbol (Spot trading)） `MONA`（Monacoin (Spot trading)）** from the Response section.**

###   2025-06-28

[The handling symbols](#parameters-ref)

* **Removed the `symbol`（Ticker Symbol）: **`XEM`（NEM (Spot trading)） `BAT`（Basic Attention Token (Spot trading)） `QTUM`（Qtum (Spot trading)） `ENJ`（Enjin Coin (Spot trading)） `XYM`（Symbol (Spot trading)） `MONA`（Monacoin (Spot trading)）** from the Parameter and Response section. **

## 2024

###   2024-12-13

Added: NOT A HOTEL COIN (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`NAC`（NOT A HOTEL COIN (Spot trading)） ** to the Parameter and Response section.**

[Assets](#assets)

- **Added a new `symbol`（Ticker Symbol）: **`NAC`（NOT A HOTEL COIN (Exchange)）** to the Response section.**

###   2024-11-02

[Assets](#assets)

- **Added a new `symbol`（Ticker Symbol）: **`AVAX`（AVAX (OTC Spot)）** to the Response section.**

###   2024-06-01

The following symbols can now specify SOK(Post-Only) in the timeInForce parameter of [Order](#order) and [Close Order](#close-order).
* `DOT_JPY`（Ticker Symbol: Polkadot-Japanese Yen (Margin trading)） `ATOM_JPY`（Cosmos-Japanese Yen (Margin trading)） `ADA_JPY`（Cardano-Japanese Yen (Margin trading)） `LINK_JPY`（Chainlink-Japanese Yen (Margin trading)） `DOGE_JPY`（Dogecoin-Japanese Yen (Margin trading)） `SOL_JPY`（Solana-Japanese Yen (Margin trading)）

###   2024-04-13

Added: Polkadot, Cosmos, Cardano, Chainlink, Dogecoin and Solana (Margin trading)

* **Added a new `symbol`（Ticker Symbol）: **`DOT_JPY`（Polkadot-Japanese Yen (Margin trading)） `ATOM_JPY`（Cosmos-Japanese Yen (Margin trading)） `ADA_JPY`（Cardano-Japanese Yen (Margin trading)） `LINK_JPY`（Chainlink-Japanese Yen (Margin trading)） `DOGE_JPY`（Dogecoin-Japanese Yen (Margin trading)） `SOL_JPY`（Solana-Japanese Yen (Margin trading)）** to the Parameter and Response section.**

###   2024-03-02

[API Limiting](#restrictions)

* **Changed: Private API limits**
  * Trading volume requirements for Tier 2 has been increased from from 100 million to over 1 billion. 
  * Tier2: Maximum 30 POST GET API requests per second for the same account.

[Fiat(JPY) deposit history](#fiatDepositHistory)has been released
[Fiat(JPY) withdrawal history](#fiatWithdrawalHistory)has been released
[CryptoCurrency deposit history](#depositHistory)has been released
[CryptoCurrency withdrawal history](#withdrawalHistory)has been released

## 2023

###   2023-12-16
The samples have been updated to correspond to the latest versions of each language as of December 16, 2023.

###   2023-12-09

[API Limiting](#restrictions)

* **Changed: Private API limits**
  * Tier1: Maximum 20 POST GET API requests per second for the same account.

###   2023-10-28
Added: New [Transfer](#transfer) has been released.

[Margin](#margin)

* **Added a new : transferableAmount to the Response section.**

###   2023-10-21

[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Trading volume requirements for Tier 2 has been reduced from 1 billion to over 100 million. 
    * Tier1: Maximum 10 POST GET API requests per second for the same account.
    * Tier2: Maximum 20 POST GET API requests per second for the same account.

###   2023-09-16

[Orders](#orders)

* **Added a new `cancelType`（Cancel Type）: **`EXPIRED_SELFTRADE`（Expired due to Self-trade.）** to the Response section.**

[Order Notifications](#ws-order-events)

* **Added a new `cancelType`（Cancel Type）: **`EXPIRED_SELFTRADE`（Expired due to Self-trade.）** to the Response section.**

###   2023-08-05

Added: Dogecoin (Spot trading),Solana (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`DOGE`（Dogecoin (Spot trading)） `SOL`（Solana (Spot trading)） ** to the Parameter and Response section.**

###   2023-07-29

[The handling symbols](#parameters-ref)

* **Removed the `symbol`（Ticker Symbol）: **`OMG`（OMG (Spot trading)）** from the Parameter and Response section. **

###   2023-07-08

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`FIL`（Filecoin (OTC Spot)） `SAND`（The Sandbox (OTC Spot)） `CHZ`（Chiliz (OTC Spot)）** to the Response section.**

###   2023-05-13
[Trading Volume](#tradingVolume)

* **Added new TradingVolume properties: TakerFee and MakerFee.**

###   2023-03-22

Added: Astar (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`ASTR`（Astar (Spot trading)）** to the Parameter and Response section.**

[Assets](#assets)

- **Added a new `symbol`（Ticker Symbol）: **`ASTR`（Astar (Exchange)）** to the Response section.**

###   2023-01-18

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`FLR`（FLARE）** to the Response section.**

## 2022

###   2022-12-21

Added: New [Trade rules](#symbols) has been released.

###   2022-10-12

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`SOL`（Solana (OTC Spot)）** to the Response section.**

###   2022-07-13

Added: Maker, Dai, Cardano and Chainlink (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`MKR`（Maker (Spot trading)） `DAI`（Dai (Spot trading)） `ADA`（Cardano (Spot trading)） `LINK`（Chainlink (Spot trading)） ** to the Parameter and Response section.**

###   2022-07-06

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`DOGE`（Dogecoin (OTC Spot)）** to the Response section.**

###   2022-06-08

Added: OMG, Tezos, Enjin Coin, Polkadot and Cosmos (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`OMG`（OMG (Spot trading)） `XTZ`（Tezos (Spot trading)） `ENJ`（Enjin Coin (Spot trading)） `DOT`（Polkadot (Spot trading)） `ATOM`（Cosmos (Spot trading)）** to the Parameter and Response section.**

###   2022-05-18

Added: FCR Coin (Spot trading)

- **Added a new `symbol`（Ticker Symbol）: **`FCR`（FCR Coin (Spot trading)）** to the Parameter and Response section.**

[Assets](#assets)

- **Added a new `symbol`（Ticker Symbol）: **`FCR`（FCR Coin (Exchange)）** to the Response section.**

###   2022-04-08

[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Trading volume requirements for Tier 2 has been reduced from 2 billion to over 1 billion. 

###   2022-03-30

Added: Basic Attention Token (Spot trading) and  Qtum (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`BAT`（Basic Attention Token (Spot trading)） `QTUM`（Qtum (Spot trading)）** to the Parameter and Response section.**

###   2022-03-02

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`LINK`（Chainlink (OTC Spot)）** to the Response section.**

###   2022-02-16

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`MKR`（Maker (OTC Spot)） `DAI`（Dai (OTC Spot)）** to the Response section.**

###   2022-01-27

[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Current week's private API limits are based on the trading volume from the previous week.

Added: New [Trading volume](#tradingVolume) has been released.

###   2022-01-26

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`ADA`（Cardano (OTC Spot)）** to the Response section.**

## 2021

###   2021-12-01

Added: Monacoin (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`MONA`（Monacoin (Spot trading)）** to the Parameter and Response section.**

###   2021-10-20

Added: Symbol (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`XYM`（Symbol (Spot trading)）** to the Parameter and Response section.**

###   2021-09-22

[Executions](#executions)
* **Added a new Executions property: positionId to Response**

[Latest Executions](#latest-executions)
* **Added a new LatestExecutions property: positionId to Response**

###   2021-09-08 

[Order](#order)
* **Added a new `timeInForce`（Time in force）: **`FAK`（Fill and kill. When an order can only be partially executed and its remaining part expires.）** into the Limit order.**

[Close Order](#close-order)
* **Added a new `timeInForce`（Time in force）: **`FAK`（Fill and kill. When an order can only be partially executed and its remaining part expires.）** into the Limit order.**

[Close Bulk Order](#close-bulk-order)
* **Added a new `timeInForce`（Time in force）: **`FAK`（Fill and kill. When an order can only be partially executed and its remaining part expires.）** into the Limit order.**

###   2021-08-18

Added: Stellar (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`XLM`（Stellar (Spot trading)）** to the Parameter and Response section.**

###   2021-08-04

[Position Summary](#position-summary)

* **Changed a `symbol`（Ticker Symbol） parameter to Optional.**

###   2021-07-14 

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`ATOM`（Cosmos (OTC Spot)）** to the Response section.**

###   2021-06-23 
Added: NEM (Spot trading)

* **Added a new `symbol`（Ticker Symbol）: **`XEM`（NEM (Spot trading)）** to the Parameter and Response section.**

###   2021-05-26
[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Maximum 6 GET API requests per second for the same account.
    * Maximum 6 GET API requests per second for the same account.

###   2021-05-19

[Assets](#assets)

* **Added a new `symbol`（Ticker Symbol）: **`DOT`（Polkadot (OTC Spot)）** to the Response section.**

###   2021-04-21

[Margin](#margin)

* **Added a new response property: marginCallStatus**

[Orders](#orders)

* **Added a new `cancelType`（Cancel Type）: **`MARGIN_CALL`（Order canceled due to a margin call.） `MARGIN_CALL_LOSSCUT`（Settlement order canceled due to a losscut from a margin call.）** to the Response section.**

[Order Notifications (Private WebSocket API)](#ws-order-events)

* **Added a new `cancelType`（Cancel Type）: **`MARGIN_CALL`（Order canceled due to a margin call.） `MARGIN_CALL_LOSSCUT`（Settlement order canceled due to a losscut from a margin call.）** to the Response section.**

###   2021-04-15

Added: New [KLine Data](#klines) has been released.

###   2021-03-10

[Margin](#margin)

* **Added a new response property: marginRatio**

## 2020

###   2020-12-16

[Executions](#executions)

* **Now you can request multiple executions at once by using a comma-separated list of execution ids.**
    * Changed the type of parameter: executionId from number to string.
    * The maximum number of execution ids is 10.

###   2020-12-09

[Order](#order)

* **Added a new Order parameter: cancelBefore**

[Close Order](#close-order)

* **Added a new Order parameter: cancelBefore**

###   2020-11-04

[Orders](#orders)

* **Now you can request multiple orders at once by using a comma-separated list of order ids.**
    * Changed the type of parameter: orderId from number to string.
    * The maximum number of order ids is 10.

Added: New [Private API](#private-api): [CancelOrders](#cancel-orders) has been released.

Added: New [Private API](#private-api): [CancelBulkOrder](#cancel-bulk-order) has been released.

###   2020-09-09

[Create Access Token](#ws-auth-post)

* **Changed the maximum number of tokens of [Private WebSocket API](#private-ws-api) from 1 to 5.**
* **If the number of issued tokens exceeds the maximum number of tokens, the tokens will be deleted in order of expiration time.**

###   2020-09-02

[Order](#order)

* **Added a new Order parameter: timeInForce**

[Close Order](#close-order)

* **Added a new Order parameter: timeInForce**

[Close Bulk Order](#close-bulk-order)

* **Added a new Order parameter: timeInForce**

[Orders](#orders)

* **Added a new `cancelType`（Cancel Type）: **`EXPIRED_FAK`（Expired by FAK） `EXPIRED_FOK`（Expired by FOK） `EXPIRED_SOK`（Expired by SOK）** to the Response section.**

* **Added a new `timeInForce`（Cancel Type）: **`FOK`（Time in force: Fill or kill. If an order is not executed immediately, the order will expire.） `SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)）** to the Response section.**

[Active Orders](#active-orders)

* **Added a new `timeInForce`（Cancel Type）: **`FOK`（Time in force: Fill or kill. If an order is not executed immediately, the order will expire.） `SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)）** to the Response section.**

[Execution Notifications](#ws-execution-events)

* **Added a new `timeInForce`（Cancel Type）: **`FOK`（Time in force: Fill or kill. If an order is not executed immediately, the order will expire.） `SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)）** to the Response section.**

[Order Notifications (Private WebSocket API)](#ws-order-events)

* **Added a new `cancelType`（Cancel Type）: **`EXPIRED_FAK`（Expired by FAK） `EXPIRED_FOK`（Expired by FOK） `EXPIRED_SOK`（Expired by SOK） `CLOSED_ORDER`（Failed to change order due to closed order） `PRICE_LIMIT`（Failed to change order due to price limit） `SOK_TAKER`（Failed to change order due to taker）** to the Response section.**

* **Added a new `timeInForce`（Cancel Type）: **`FOK`（Time in force: Fill or kill. If an order is not executed immediately, the order will expire.） `SOK`（Store or kill. If a limit order is not maker, the order will expire. (Post-only order)）** to the Response section.**

###   2020-08-12
[Position Summary Notifications](#ws-position-summary-events)

* **Added a new Position Summary Notifications parameter: option**
* **Added a new response property: msgType**

###   2020-08-05
[Orders](#orders)

* **Added a new `cancelType`（Cancel Type）: **`INSUFFICIENT_BALANCE`（Canceled the order due to the insufficient available amount. (Spot trading)） `INSUFFICIENT_MARGIN`（Canceled the order due to the insufficient available amount. (Margin trading)） `ACCOUNT_LOSSCUT`（Canceled the margin trading order because of insufficient balance in your account due to loss-cut.）** to the Response section.**

[Order Notifications (Private WebSocket API)](#ws-order-events)

* **Added a new `cancelType`（Cancel Type）: **`INSUFFICIENT_BALANCE`（Canceled the order due to the insufficient available amount. (Spot trading)） `INSUFFICIENT_MARGIN`（Canceled the order due to the insufficient available amount. (Margin trading)） `ACCOUNT_LOSSCUT`（Canceled the margin trading order because of insufficient balance in your account due to loss-cut.）** to the Response section.**

###   2020-07-28
Added: New [Historical Data](#historical_data) has been released.

* **You can download the historical data (.CSV file).**

###   2020-07-15
[Order](#order)

* **Added a new Order parameter: losscutPrice**

###   2020-07-08
Added: New [Private WebSocket API](#private-ws-api): [Position Summary Notifications](#ws-position-summary-events) has been released.

* **To use the API with the existing API keys, open your membership site > API > 編集 (Edit) > APIキーの編集 (API key setting) screen and click "約定情報通知(WebSocket)" (Execution Notifications), "注文情報通知(WebSocket)" (Order Notifications), "ポジション情報通知(WebSocket)" (Position Notifications) or "ポジション情報通知(WebSocket)" (Position Summary Notifications) to call the Create Access Token API.**

###   2020-06-24
[Orders](#orders)

* **Added a new response property: cancelType**

[Order Notifications (Private WebSocket API)](#ws-order-events)

* **Added a new response property: cancelType**

###   2020-05-27
[Change Order](#change-order)

* **Added a new Change Order parameter: losscutPrice**

[Orders](#orders)

* **Added a new response property: losscutPrice**

[Active Orders](#active-orders)

* **Added a new response property: losscutPrice**

[Order Notifications (Private WebSocket API)](#ws-order-events)

* **Added a new response property: losscutPrice**

###   2020-04-28
Added: New [Private WebSocket API](#private-ws-api): [Position Notifications](#ws-position-events) has been released.

* **To use the API with the existing API keys, open your membership site > API > 編集 (Edit) > APIキーの編集 (API key setting) screen and click "約定情報通知(WebSocket)" (Execution Notifications), "注文情報通知(WebSocket)" (Order Notifications) or "ポジション情報通知(WebSocket)" (Position Notifications) to call the Create Access Token API.**

###   2020-04-08
[Order Books (Public WebSocket API)](#ws-orderbooks)

* **Added a new response property: timestamp**

###   2020-04-01
[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Private API limits for GET and POST method are now separated.
        * Maximum 3 GET API requests per second for the same account.
        * Maximum 3 POST API requests per second for the same account.

###   2020-02-26
Added: New [Private WebSocket API](#private-ws-api): [Order Notifications](#ws-order-events) has been released.

* **To use the API with the existing API keys, open your membership site > API > 編集 (Edit) > APIキーの編集 (API key setting) screen and click "約定情報通知(WebSocket)" (Execution Notifications) or "注文情報通知(WebSocket)" (Order Notifications) to call the Create Access Token API.**

[Execution Notifications (Private WebSocket API)](#ws-execution-events)

* **Added a new response property: msgType**

Added a new section: [Feedback](#feedback) page

###   2020-02-12
Request example

* **Request example of Swift has been added.**
* **WebSocket4Net version of C# request example has been added.**

###   2020-01-23
[Private WebSocket API](#private-ws-api) version v1 has been released.

[API Limiting](#restrictions)

* **Added: Private WebSocket API Limiting**
    * Description of API usage restriction of Private WebSocket API to Limits section has been added.

## 2019

###   2019-11-27
[Trades (Public WebSocket API)](#ws-trades)

* **Added a new Trade parameter: option**

###   2019-11-20
Added: English version of API documentation has been released.

###   2019-10-23
Added: Stop limit order.

* Please note that meaning of order status `WAITING` will be valid and `ORDERED` will be partially executed for stop limit orders.

[Order](#order)

* Added a new `executionType`（Execution Type）: `STOP`（Stop limit order） to the Parameter section.
* Added a description of `price`（Price of the order） to the Parameter section.

[Close Order](#close-order)

* Added a new `executionType`（Execution Type）: `STOP`（Stop limit order） to the Parameter section.
* Added a description of `price`（Price of the order） to the Parameter section.

[Close Bulk Order](#close-bulk-order)

* Added a new `executionType`（Execution Type）: `STOP`（Stop limit order） to the Parameter section.
* Added a description of `price`（Price of the order） to the Parameter section.
 
[Orders](#orders)

* Added a new `executionType`（Execution Type）: `STOP`（Stop limit order） to the Parameter section.
* Added a description of `status`（Order Status） to the Parameter section.

[Active Orders](#active-orders)

* Added a new `executionType`（Execution Type）: `STOP`（Stop limit order） to the Parameter section.
* Changed the description of `status`（Order Status） in the Response section.

###   2019-10-02
Added: New [Public WebSocket API](#public-ws-api): [Trades](#ws-trades) has been released.

###   2019-09-18
Request example of C#, Rust, and Haskell has been added.

###   2019-09-11
Request example of Go, Ruby, PHP, and Kotlin has been added.

###   2019-08-28
[Public WebSocket API](#public-ws-api) version v1 has been released.

[API Limiting](#restrictions)

* **Added: Public WebSocket API limits**
    * Description of API usage restriction of Public WebSocket API to Limits section has been added.

###   2019-07-03
[API Limiting](#restrictions)

* **Changed: Private API limits**
    * Private API limits are changed to once per 300 milliseconds.

###   2019-06-12
[GET /public/v1/ticker](#ticker)

* **Changed: Symbol parameter is changed from required to optional**
    * If symbol is not specified, now it returns all symbols' rates.

###   2019-05-29
Version v1 has been released.
