ContextQMD
Back to Ccxt

Coinsph

wiki/exchanges/coinsph.md

4.5.5220.1 KB
Original Source

<a name="coinsph" id="coinsph"></a>

coinsph{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://docs.coins.ph/rest-api/#all-coins-information-user_data

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchCurrencies ([params])

<a name="fetchStatus" id="fetchstatus"></a>

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - a status structure

See: https://coins-docs.github.io/rest-api/#test-connectivity

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchStatus ([params])

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of <code>coinsph</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See: https://coins-docs.github.io/rest-api/#check-server-time

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchTime ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for coinsph

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<object></code> - an array of objects representing market data

See: https://coins-docs.github.io/rest-api/#exchange-information

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchMarkets ([params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - a dictionary of ticker structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchTickers (symbols[, params])

<a name="fetchTicker" id="fetchticker"></a>

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 <code>coinsph</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchTicker (symbol[, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://coins-docs.github.io/rest-api/#order-book

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return (default 100, max 200)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchOrderBook (symbol[, limit, params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

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 <code>coinsph</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://coins-docs.github.io/rest-api/#klinecandlestick-data

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch (default 500, max 1000)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest candle to fetch
javascript
coinsph.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://coins-docs.github.io/rest-api/#recent-trades-list

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch (default 500, max 1000)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchTrades (symbol[, since, limit, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://coins-docs.github.io/rest-api/#account-trade-list-user_data

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve (default 500, max 1000)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchMyTrades (symbol[, since, limit, params])

<a name="fetchOrderTrades" id="fetchordertrades"></a>

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://coins-docs.github.io/rest-api/#account-trade-list-user_data

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchOrderTrades (id, symbol[, since, limit, params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - a balance structure

See: https://coins-docs.github.io/rest-api/#accept-the-quote

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchBalance ([params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - an order structure

See: https://coins-docs.github.io/rest-api/#new-order--trade

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market', 'limit', 'stop_loss', 'take_profit', 'stop_loss_limit', 'take_profit_limit' or 'limit_maker'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.cost<code>float</code>Nothe quote quantity that can be used as an alternative for the amount for market buy orders
params.test<code>bool</code>Noset to true to test an order, no order will be created but the request will be validated
javascript
coinsph.createOrder (symbol, type, side, amount[, price, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - An order structure

See: https://coins-docs.github.io/rest-api/#query-order-user_data

ParamTypeRequiredDescription
id<code>int</code>, <code>string</code>Yesorder id
symbol<code>string</code>Yesnot used by coinsph fetchOrder ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchOrder (id, symbol[, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://coins-docs.github.io/rest-api/#current-open-orders-user_data

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://coins-docs.github.io/rest-api/#history-orders-user_data

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve (default 500, max 1000)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchClosedOrders (symbol[, since, limit, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - An order structure

See: https://coins-docs.github.io/rest-api/#cancel-order-trade

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesnot used by coinsph cancelOrder ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.cancelOrder (id, symbol[, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel open orders of market

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<object></code> - a list of order structures

See: https://coins-docs.github.io/rest-api/#cancel-all-open-orders-on-a-symbol-trade

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.cancelAllOrders (symbol[, params])

<a name="fetchTradingFee" id="fetchtradingfee"></a>

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - a fee structure

See: https://coins-docs.github.io/rest-api/#trade-fee-user_data

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchTradingFee (symbol[, params])

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - a dictionary of fee structures indexed by market symbols

See: https://coins-docs.github.io/rest-api/#trade-fee-user_data

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchTradingFees ([params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal to coins_ph account

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - a transaction structure

See: https://coins-docs.github.io/rest-api/#withdrawuser_data

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesnot used by coinsph withdraw ()
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.withdraw (code, amount, address, tag[, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://coins-docs.github.io/rest-api/#deposit-history-user_data

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>coinsph</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://coins-docs.github.io/rest-api/#withdraw-history-user_data

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinsph.fetchWithdrawals (code[, since, limit, params])

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>coinsph</code>
Returns: <code>object</code> - an address structure

See: https://coins-docs.github.io/rest-api/#deposit-address-user_data

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Nonetwork for fetch deposit address
javascript
coinsph.fetchDepositAddress (code[, params])