20 KiB
coinsph{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchCurrencies
- fetchStatus
- fetchTime
- fetchMarkets
- fetchTickers
- fetchTicker
- fetchOrderBook
- fetchOHLCV
- fetchTrades
- fetchMyTrades
- fetchOrderTrades
- fetchBalance
- createOrder
- fetchOrder
- fetchOpenOrders
- fetchClosedOrders
- cancelOrder
- cancelAllOrders
- fetchTradingFee
- fetchTradingFees
- withdraw
- fetchDeposits
- fetchWithdrawals
- fetchDepositAddress
fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
Kind: instance method of coinsph
Returns: object - an associative dictionary of currencies
See: https://docs.coins.ph/rest-api/#all-coins-information-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchCurrencies ([params])
fetchStatus{docsify-ignore}
the latest known information on the availability of the exchange API
Kind: instance method of coinsph
Returns: object - a status structure
See: https://coins-docs.github.io/rest-api/#test-connectivity
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchStatus ([params])
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of coinsph
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://coins-docs.github.io/rest-api/#check-server-time
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchTime ([params])
fetchMarkets{docsify-ignore}
retrieves data on all markets for coinsph
Kind: instance method of coinsph
Returns: Array<object> - an array of objects representing market data
See: https://coins-docs.github.io/rest-api/#exchange-information
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchMarkets ([params])
fetchTickers{docsify-ignore}
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of coinsph
Returns: object - a dictionary of ticker structures
See
- https://coins-docs.github.io/rest-api/#24hr-ticker-price-change-statistics
- https://coins-docs.github.io/rest-api/#symbol-price-ticker
- https://coins-docs.github.io/rest-api/#symbol-order-book-ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined |
Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchTickers (symbols[, 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 coinsph
Returns: object - a ticker structure
See
- https://coins-docs.github.io/rest-api/#24hr-ticker-price-change-statistics
- https://coins-docs.github.io/rest-api/#symbol-price-ticker
- https://coins-docs.github.io/rest-api/#symbol-order-book-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 |
coinsph.fetchTicker (symbol[, params])
fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of coinsph
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://coins-docs.github.io/rest-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 (default 100, max 200) |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchOrderBook (symbol[, limit, params])
fetchOHLCV{docsify-ignore}
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of coinsph
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://coins-docs.github.io/rest-api/#klinecandlestick-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
Yes | the length of time each candle represents |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch (default 500, max 1000) |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | timestamp in ms of the latest candle to fetch |
coinsph.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of coinsph
Returns: Array<Trade> - a list of trade structures
See: https://coins-docs.github.io/rest-api/#recent-trades-list
| 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 (default 500, max 1000) |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchTrades (symbol[, since, limit, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of coinsph
Returns: Array<Trade> - a list of trade structures
See: https://coins-docs.github.io/rest-api/#account-trade-list-user_data
| 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 (default 500, max 1000) |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchMyTrades (symbol[, since, limit, params])
fetchOrderTrades{docsify-ignore}
fetch all the trades made from a single order
Kind: instance method of coinsph
Returns: Array<object> - a list of trade structures
See: https://coins-docs.github.io/rest-api/#account-trade-list-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| 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 to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchOrderTrades (id, symbol[, since, limit, params])
fetchBalance{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of coinsph
Returns: object - a balance structure
See: https://coins-docs.github.io/rest-api/#accept-the-quote
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchBalance ([params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of coinsph
Returns: object - an order structure
See: https://coins-docs.github.io/rest-api/#new-order--trade
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | 'market', 'limit', 'stop_loss', 'take_profit', 'stop_loss_limit', 'take_profit_limit' or 'limit_maker' |
| 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 |
| params.cost | float |
No | the quote quantity that can be used as an alternative for the amount for market buy orders |
| params.test | bool |
No | set to true to test an order, no order will be created but the request will be validated |
coinsph.createOrder (symbol, type, side, amount[, price, params])
fetchOrder{docsify-ignore}
fetches information on an order made by the user
Kind: instance method of coinsph
Returns: object - An order structure
See: https://coins-docs.github.io/rest-api/#query-order-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| id | int, string |
Yes | order id |
| symbol | string |
Yes | not used by coinsph fetchOrder () |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchOrder (id, symbol[, params])
fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
Kind: instance method of coinsph
Returns: Array<Order> - a list of order structures
See: https://coins-docs.github.io/rest-api/#current-open-orders-user_data
| 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 |
coinsph.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
Kind: instance method of coinsph
Returns: Array<Order> - a list of order structures
See: https://coins-docs.github.io/rest-api/#history-orders-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve (default 500, max 1000) |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchClosedOrders (symbol[, since, limit, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of coinsph
Returns: object - An order structure
See: https://coins-docs.github.io/rest-api/#cancel-order-trade
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | not used by coinsph cancelOrder () |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.cancelOrder (id, symbol[, params])
cancelAllOrders{docsify-ignore}
cancel open orders of market
Kind: instance method of coinsph
Returns: Array<object> - a list of order structures
See: https://coins-docs.github.io/rest-api/#cancel-all-open-orders-on-a-symbol-trade
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.cancelAllOrders (symbol[, params])
fetchTradingFee{docsify-ignore}
fetch the trading fees for a market
Kind: instance method of coinsph
Returns: object - a fee structure
See: https://coins-docs.github.io/rest-api/#trade-fee-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchTradingFee (symbol[, params])
fetchTradingFees{docsify-ignore}
fetch the trading fees for multiple markets
Kind: instance method of coinsph
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://coins-docs.github.io/rest-api/#trade-fee-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.fetchTradingFees ([params])
withdraw{docsify-ignore}
make a withdrawal to coins_ph account
Kind: instance method of coinsph
Returns: object - a transaction structure
See: https://coins-docs.github.io/rest-api/#withdrawuser_data
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | the amount to withdraw |
| address | string |
Yes | not used by coinsph withdraw () |
| tag | string |
Yes | |
| params | object |
No | extra parameters specific to the exchange API endpoint |
coinsph.withdraw (code, amount, address, tag[, params])
fetchDeposits{docsify-ignore}
fetch all deposits made to an account
Kind: instance method of coinsph
Returns: Array<object> - a list of transaction structures
See: https://coins-docs.github.io/rest-api/#deposit-history-user_data
| 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 |
coinsph.fetchDeposits (code[, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
Kind: instance method of coinsph
Returns: Array<object> - a list of transaction structures
See: https://coins-docs.github.io/rest-api/#withdraw-history-user_data
| 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 |
coinsph.fetchWithdrawals (code[, since, limit, params])
fetchDepositAddress{docsify-ignore}
fetch the deposit address for a currency associated with this account
Kind: instance method of coinsph
Returns: object - an address structure
See: https://coins-docs.github.io/rest-api/#deposit-address-user_data
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.network | string |
No | network for fetch deposit address |
coinsph.fetchDepositAddress (code[, params])