Skip to content

arkham

Jump to bottom
github-actions[bot] edited this page Apr 6, 2026 · 1 revision

arkham{docsify-ignore}

Kind: global class
Extends: Exchange

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of arkham
Returns: object - an associative dictionary of currencies

See: https://arkm.com/docs#get/public/assets

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchCurrencies ([params])

fetchMarkets{docsify-ignore}

retrieves data on all markets for arkm

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

See: https://arkm.com/docs#get/public/pairs

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchMarkets ([params])

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of arkham
Returns: int - the current integer timestamp in milliseconds from the exchange server

See: https://arkm.com/docs#get/public/server-time

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchTime ([params])

fetchOrderBook{docsify-ignore}

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

Kind: instance method of arkham
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://arkm.com/docs#get/public/book

Param Type Required Description
symbol string Yes unified symbol of the market to fetch the order book for
limit int No the number of order book entries to return, max 50
params object No extra parameters specific to the exchange API endpoint 
arkham.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 arkham
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://arkm.com/docs#get/public/candles

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
params object No extra parameters specific to the exchange API endpoint
params.until int No timestamp in ms for the ending date filter, default is the current time
params.paginate boolean No default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters 
arkham.fetchOHLCV (symbol, timeframe[, since, 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 arkham
Returns: object - a ticker structure

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 
arkham.fetchTicker (symbol[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of arkham
Returns: Array<Trade> - a list of trade structures

See: https://arkm.com/docs#get/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
params.loc string No crypto location, default: us
params.method string No method, default: marketPublicGetV1beta3CryptoLocTrades 
arkham.fetchTrades (symbol[, since, limit, params])

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of arkham
Returns: Array<Order> - a list of order structures

See: https://arkm.com/docs#get/orders/history

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
params object No extra parameters specific to the exchange API endpoint
params.until int No the latest time in ms to fetch orders for 
arkham.fetchClosedOrders (symbol[, since, limit, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of arkham
Returns: Array<Order> - a list of order structures

See: https://arkm.com/docs#get/orders

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
params object No extra parameters specific to the exchange API endpoint
params.until int No the latest time in ms to fetch orders for 
arkham.fetchOpenOrders (symbol[, since, limit, params])

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of arkham
Returns: object - An order structure

See: https://arkm.com/docs#post/orders/cancel

Param Type Required Description
id string Yes order id
symbol string Yes unified symbol of the market the order was made in
params object No extra parameters specific to the exchange API endpoint 
arkham.cancelOrder (id, symbol[, params])

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

Kind: instance method of arkham
Returns: Array<object> - a list of order structures

See: https://arkm.com/docs#post/orders/cancel/all

Param Type Required Description
symbol string Yes cancel alls open orders
params object No extra parameters specific to the exchange API endpoint 
arkham.cancelAllOrders (symbol[, params])

createOrder{docsify-ignore}

create a trade order on the exchange

Kind: instance method of arkham
Returns: An order structure

See: https://arkm.com/docs#post/orders/new

Param Type Required Description
symbol string Yes unified CCXT market symbol
type string Yes "limit" or "market"
side string Yes "buy" or "sell"
amount float Yes the amount of currency to trade
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.timeInForce string No "GTC", "IOC", "FOK", or "PO"
params.triggerPrice float No price for a trigger (conditional) order
params.stopLossPrice float No price for a stoploss order
params.takeProfitPrice float No price for a takeprofit order
params.triggerDirection string No the direction for trigger orders, 'ascending' or 'descending'
params.triggerPriceType string No mark, index or last
params.postOnly bool No true or false whether the order is post-only
params.reduceOnly bool No true or false whether the order is reduce-only 
arkham.createOrder (symbol, type, side, amount[, price, params])

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of arkham
Returns: Array<Trade> - a list of trade structures

See: https://arkm.com/docs#get/trades/time

Param Type Required Description
symbol string No unified market symbol
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
params.until int No the latest time in ms to fetch trades for
params.page_token string No page_token - used for paging 
arkham.fetchMyTrades ([symbol, since, limit, params])

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of arkham
Returns: object - a dictionary of account structures indexed by the account type

See: https://arkm.com/docs#get/user

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchAccounts ([params])

fetchBalance{docsify-ignore}

query for account info

Kind: instance method of arkham
Returns: object - a balance structure

See: https://arkm.com/docs#get/account/balances

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchBalance ([params])

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of arkham
Returns: object - an address structure

See: https://arkm.com/docs#post/account/deposit/addresses/new

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 
arkham.createDepositAddress (code[, params])

fetchDepositAddressesByNetwork{docsify-ignore}

fetch the deposit addresses for a currency associated with this account

Kind: instance method of arkham
Returns: object - a dictionary address structures, indexed by the network

See: https://arkm.com/docs#get/account/deposit/addresses

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchDepositAddressesByNetwork (code[, params])

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of arkham
Returns: object - an address structure

See: https://arkm.com/docs#get/account/deposit/addresses

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchDepositAddress (code[, params])

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of arkham
Returns: Array<object> - a list of transaction structures

See: https://arkm.com/docs#get/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 
arkham.fetchDeposits (code[, since, limit, params])

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of arkham
Returns: object - a dictionary of fee structures indexed by market symbols

See: https://arkm.com/docs#get/account/fees

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
params.subType string No "linear" or "inverse" 
arkham.fetchTradingFees ([params])

fetchFundingHistory{docsify-ignore}

fetch the history of funding payments paid and received on this account

Kind: instance method of arkham
Returns: object - a funding history structure

See: https://arkm.com/docs#get/account/funding-rate-payments

Param Type Required Description
symbol string No unified market symbol
since int No the earliest time in ms to fetch funding history for
limit int No the maximum number of funding history structures to retrieve
params object No extra parameters specific to the exchange API endpoint
params.paginate boolean No default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters 
arkham.fetchFundingHistory ([symbol, since, limit, params])

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

Kind: instance method of arkham
Returns: object - a leverage structure

See: https://arkm.com/docs#get/account/leverage

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchLeverage (symbol[, params])

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of arkham
Returns: object - response from the exchange

See: https://arkm.com/docs#post/account/leverage

Param Type Required Description
leverage float Yes the rate of leverage
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
arkham.setLeverage (leverage, symbol[, params])

fetchLeverageTiers{docsify-ignore}

retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes

Kind: instance method of arkham
Returns: object - a dictionary of leverage tiers structures, indexed by market symbols

See: https://arkm.com/docs#get/public/margin-schedules

Param Type Required Description
symbols Array<string>, undefined Yes list of unified market symbols
params object No extra parameters specific to the exchange API endpoint 
arkham.fetchLeverageTiers (symbols[, params])

watchTicker{docsify-ignore}

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of arkham
Returns: object - a ticker structure

See: https://arkm.com/docs#stream/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 
arkham.watchTicker (symbol[, params])

watchOHLCV{docsify-ignore}

watches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of arkham
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://arkm.com/docs#stream/candles

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
params object No extra parameters specific to the exchange API endpoint 
arkham.watchOHLCV (symbol, timeframe[, 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 arkham
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://arkm.com/docs#stream/l2_updates

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 
arkham.watchOrderBook (symbol[, limit, params])

watchTrades{docsify-ignore}

watches information on multiple trades made in a market

Kind: instance method of arkham
Returns: Array<object> - a list of trade structures

See: https://arkm.com/docs#stream/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 orders for
limit int No the maximum number of trade structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
arkham.watchTrades (symbol[, since, limit, params])

watchBalance{docsify-ignore}

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

Kind: instance method of arkham
Returns: object - a balance structure

See: https://arkm.com/docs#stream/balances

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
params.type str No spot or contract if not provided this.options['defaultType'] is used 
arkham.watchBalance ([params])

watchPositions{docsify-ignore}

watch all open positions

Kind: instance method of arkham
Returns: Array<object> - a list of position structure

See: https://arkm.com/docs#stream/positions

Param Type Required Description
symbols Array<string> No list of unified market symbols
since int No the earliest time in ms to fetch positions for
limit int No the maximum number of positions to retrieve
params object Yes extra parameters specific to the exchange API endpoint 
arkham.watchPositions ([symbols, since, limit, params])

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of arkham
Returns: Array<object> - a list of order structures

See: https://arkm.com/docs#stream/order_statuses

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
params object No extra parameters specific to the exchange API endpoint 
arkham.watchOrders (symbol[, since, limit, params])

(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)

Clone this wiki locally