11 KiB
coincheck{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchBalance
- fetchOpenOrders
- fetchOrderBook
- fetchTicker
- fetchMyTrades
- fetchTrades
- fetchTradingFees
- createOrder
- cancelOrder
- fetchDeposits
- fetchWithdrawals
- watchOrderBook
- watchTrades
fetchBalance{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of coincheck
Returns: object - a balance structure
See: https://coincheck.com/documents/exchange/api#order-transactions-pagination
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchBalance ([params])
fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
Kind: instance method of coincheck
Returns: Array<Order> - a list of order structures
See: https://coincheck.com/documents/exchange/api#order-opens
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch open orders for |
| limit | int |
No | the maximum number of open orders structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchOpenOrders (symbol[, since, limit, params])
fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of coincheck
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://coincheck.com/documents/exchange/api#order-book
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchOrderBook (symbol[, limit, params])
fetchTicker{docsify-ignore}
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of coincheck
Returns: object - a ticker structure
See: https://coincheck.com/documents/exchange/api#ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchTicker (symbol[, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of coincheck
Returns: Array<Trade> - a list of trade structures
See: https://coincheck.com/documents/exchange/api#order-transactions-pagination
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trades structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchMyTrades (symbol[, since, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of coincheck
Returns: Array<Trade> - a list of trade structures
See: https://coincheck.com/documents/exchange/api#public-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchTrades (symbol[, since, limit, params])
fetchTradingFees{docsify-ignore}
fetch the trading fees for multiple markets
Kind: instance method of coincheck
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://coincheck.com/documents/exchange/api#account-info
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchTradingFees ([params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of coincheck
Returns: object - an order structure
See: https://coincheck.com/documents/exchange/api#order-new
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | 'market' or 'limit' |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | how much of currency you want to trade in units of base currency |
| price | float |
No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.createOrder (symbol, type, side, amount[, price, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of coincheck
Returns: object - An order structure
See: https://coincheck.com/documents/exchange/api#order-cancel
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | not used by coincheck cancelOrder () |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.cancelOrder (id, symbol[, params])
fetchDeposits{docsify-ignore}
fetch all deposits made to an account
Kind: instance method of coincheck
Returns: Array<object> - a list of transaction structures
See: https://coincheck.com/documents/exchange/api#account-deposits
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch deposits for |
| limit | int |
No | the maximum number of deposits structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchDeposits (code[, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
Kind: instance method of coincheck
Returns: Array<object> - a list of transaction structures
See: https://coincheck.com/documents/exchange/api#withdraws
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch withdrawals for |
| limit | int |
No | the maximum number of withdrawals structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.fetchWithdrawals (code[, since, limit, params])
watchOrderBook{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of coincheck
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://coincheck.com/documents/exchange/api#websocket-order-book
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.watchOrderBook (symbol[, limit, params])
watchTrades{docsify-ignore}
watches information on multiple trades made in a market
Kind: instance method of coincheck
Returns: Array<object> - a list of trade structures
See: https://coincheck.com/documents/exchange/api#websocket-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market trades were made in |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trade structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coincheck.watchTrades (symbol[, since, limit, params])