Paymium - Ccxt — ContextQMD

paymium{docsify-ignore}

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

fetchBalance
fetchOrderBook
fetchTicker
fetchTrades
createDepositAddress
fetchDepositAddress
fetchDepositAddresses
createOrder
cancelOrder
transfer

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>paymium</code>
Returns: <code>object</code> - a balance structure

See: https://paymium.github.io/api-documentation/#tag/User/operation/get-user-info

Param	Type	Required	Description
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.fetchBalance ([params])

fetchOrderBook{docsify-ignore}

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

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

See: https://paymium.github.io/api-documentation/#tag/Public-data/operation/get-market-depth

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to fetch the order book for
limit	<code>int</code>	No	the maximum amount of order book entries to return
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

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

See: https://paymium.github.io/api-documentation/#tag/Public-data/operation/get-latest-ticker

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to fetch the ticker for
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.fetchTicker (symbol[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://paymium.github.io/api-documentation/#tag/Public-data/operation/get-latest-trades

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to fetch trades for
since	<code>int</code>	No	timestamp in ms of the earliest trade to fetch
limit	<code>int</code>	No	the maximum amount of trades to fetch
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.fetchTrades (symbol[, since, limit, params])

createDepositAddress{docsify-ignore}

create a currency deposit address

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

See: https://paymium.github.io/api-documentation/#tag/User/operation/create-deposit-address

Param	Type	Required	Description
code	<code>string</code>	Yes	unified currency code of the currency for the deposit address
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.createDepositAddress (code[, params])

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

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

See: https://paymium.github.io/api-documentation/#tag/User/operation/get-deposit-address

Param	Type	Required	Description
code	<code>string</code>	Yes	unified currency code
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.fetchDepositAddress (code[, params])

fetchDepositAddresses{docsify-ignore}

fetch deposit addresses for multiple currencies and chain types

Kind: instance method of <code>paymium</code>
Returns: <code>object</code> - a list of address structures

See: https://paymium.github.io/api-documentation/#tag/User/operation/get-deposit-addresses

Param	Type	Required	Description
codes	<code>Array<string></code>, <code>undefined</code>	Yes	list of unified currency codes, default is undefined
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.fetchDepositAddresses (codes[, params])

createOrder{docsify-ignore}

create a trade order

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

See: https://paymium.github.io/api-documentation/#tag/Order/operation/create-order

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to create an order in
type	<code>string</code>	Yes	'market' or 'limit'
side	<code>string</code>	Yes	'buy' or 'sell'
amount	<code>float</code>	Yes	how much of currency you want to trade in units of base currency
price	<code>float</code>	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.createOrder (symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://paymium.github.io/api-documentation/#tag/Order/operation/cancel-order

Param	Type	Required	Description
id	<code>string</code>	Yes	order id
symbol	<code>string</code>	Yes	not used by paymium cancelOrder ()
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.cancelOrder (id, symbol[, params])

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of <code>paymium</code>
Returns: <code>object</code> - a transfer structure

See: https://paymium.github.io/api-documentation/#tag/Transfer/operation/create-email-transfer

Param	Type	Required	Description
code	<code>string</code>	Yes	unified currency code
amount	<code>float</code>	Yes	amount to transfer
fromAccount	<code>string</code>	Yes	account to transfer from
toAccount	<code>string</code>	Yes	account to transfer to
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

paymium.transfer (code, amount, fromAccount, toAccount[, params])