## paymium{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchBalance](#fetchbalance) * [fetchOrderBook](#fetchorderbook) * [fetchTicker](#fetchticker) * [fetchTrades](#fetchtrades) * [createDepositAddress](#createdepositaddress) * [fetchDepositAddress](#fetchdepositaddress) * [fetchDepositAddresses](#fetchdepositaddresses) * [createOrder](#createorder) * [cancelOrder](#cancelorder) * [transfer](#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 [paymium](#paymium) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://paymium.github.io/api-documentation/#tag/User/paths/~1user/get | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | 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 [paymium](#paymium) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1depth/get | 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 | ```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 [paymium](#paymium) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1ticker/get | 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 | ```javascript paymium.fetchTicker (symbol[, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [paymium](#paymium) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1trades/get | 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 | ```javascript paymium.fetchTrades (symbol[, since, limit, params]) ``` ### createDepositAddress{docsify-ignore} create a currency deposit address **Kind**: instance method of [paymium](#paymium) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/post | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency for the deposit address | | params | object | 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 [paymium](#paymium) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses~1%7Baddress%7D/get | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | 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 [paymium](#paymium) **Returns**: object - a list of [address structures](https://docs.ccxt.com/#/?id=address-structure) **See**: https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/get | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | list of unified currency codes, default is undefined | | params | object | 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 [paymium](#paymium) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders/post | 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 | ```javascript paymium.createOrder (symbol, type, side, amount[, price, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [paymium](#paymium) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D/delete - https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D~1cancel/delete | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | not used by paymium cancelOrder () | | params | object | 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 [paymium](#paymium) **Returns**: object - a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://paymium.github.io/api-documentation/#tag/Transfer/paths/~1user~1email_transfers/post | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | amount to transfer | | fromAccount | string | Yes | account to transfer from | | toAccount | string | Yes | account to transfer to | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript paymium.transfer (code, amount, fromAccount, toAccount[, params]) ```