bitstamp

bitstamp{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchCurrencies
• fetchOrderBook
• fetchTicker
• fetchTickers
• fetchTrades
• fetchOHLCV
• fetchBalance
• fetchTradingFee
• fetchTradingFees
• fetchTransactionFees
• fetchDepositWithdrawFees
• createOrder
• editOrder
• cancelOrder
• cancelAllOrders
• fetchOrder
• fetchMyTrades
• fetchFundingRateHistory
• fetchDepositsWithdrawals
• fetchWithdrawals
• fetchLedger
• fetchFundingRate
• fetchOpenOrders
• fetchDepositAddress
• withdraw
• transfer
• watchOrderBook
• watchTrades
• watchOrders

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitstamp

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

See: https://www.bitstamp.net/api/#tag/Market-info/operation/GetTradingPairsInfo

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchMarkets (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://www.bitstamp.net/api/#tag/Market-info/operation/GetTradingPairsInfo

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchCurrencies (params?)

fetchOrderBook{docsify-ignore}

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

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

See: https://www.bitstamp.net/api/#tag/Order-book/operation/GetOrderBook

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

bitstamp.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 bitstamp
Returns: object - a ticker structure

See: https://www.bitstamp.net/api/#tag/Tickers/operation/GetMarketTicker

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

bitstamp.fetchTicker (symbol, 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 bitstamp
Returns: object - a dictionary of ticker structures

See: https://www.bitstamp.net/api/#tag/Tickers/operation/GetCurrencyPairTickers

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

bitstamp.fetchTickers (symbols, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://www.bitstamp.net/api/#tag/Transactions-public/operation/GetTransactions

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

bitstamp.fetchTrades (symbol, since?, 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 bitstamp
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://www.bitstamp.net/api/#tag/Market-info/operation/GetOHLCData

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

bitstamp.fetchOHLCV (symbol, timeframe, 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 bitstamp
Returns: object - a balance structure

See: https://www.bitstamp.net/api/#tag/Account-balances/operation/GetAccountBalances

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchBalance (params?)

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of bitstamp
Returns: object - a fee structure

See: https://www.bitstamp.net/api/#tag/Fees/operation/GetTradingFeesForCurrency

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchTradingFee (symbol, params?)

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

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

See: https://www.bitstamp.net/api/#tag/Fees/operation/GetAllTradingFees

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchTradingFees (params?)

fetchTransactionFees{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFees instead

Kind: instance method of bitstamp
Returns: Array<object> - a list of fee structures

See: https://www.bitstamp.net/api/#tag/Fees

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

bitstamp.fetchTransactionFees (codes, params?)

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of bitstamp
Returns: Array<object> - a list of fee structures

See: https://www.bitstamp.net/api/#tag/Fees/operation/GetAllWithdrawalFees

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

bitstamp.fetchDepositWithdrawFees (codes, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of bitstamp
Returns: object - an order structure

See

• https://www.bitstamp.net/api/#tag/Orders/operation/OpenInstantBuyOrder
• https://www.bitstamp.net/api/#tag/Orders/operation/OpenMarketBuyOrder
• https://www.bitstamp.net/api/#tag/Orders/operation/OpenLimitBuyOrder
• https://www.bitstamp.net/api/#tag/Orders/operation/OpenInstantSellOrder
• https://www.bitstamp.net/api/#tag/Orders/operation/OpenMarketSellOrder
• https://www.bitstamp.net/api/#tag/Orders/operation/OpenLimitSellOrder

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

bitstamp.createOrder (symbol, type, side, amount, price?, params?)

editOrder{docsify-ignore}

edit a trade order

Kind: instance method of bitstamp
Returns: object - an order structure

See: https://www.bitstamp.net/api/#tag/Orders/operation/ReplaceOrder

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	No	unified symbol of the market to create an order in
type	string	No	'market', 'limit' or 'stop_limit'
side	string	No	'buy' or 'sell'
amount	float	No	how much of the currency you want to trade in units of the base currency
price	float	No	the price for the order, in units of the quote currency, ignored in market orders
params	object	No	extra parameters specific to the exchange API endpoint
params.triggerPrice	string	No	the price to trigger a stop order
params.timeInForce	string	No	for crypto trading either 'gtc' or 'ioc' can be used
params.clientOrderId	string	No	a unique identifier for the order, automatically generated if not sent

bitstamp.editOrder (id, symbol?, type?, side?, amount?, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://www.bitstamp.net/api/#tag/Orders/operation/CancelOrder

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

bitstamp.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See

• https://www.bitstamp.net/api/#tag/Orders/operation/CancelAllOrders
• https://www.bitstamp.net/api/#tag/Orders/operation/CancelOrdersForMarket

Param	Type	Required	Description
symbol	string	Yes	unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.cancelAllOrders (symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://www.bitstamp.net/api/#tag/Orders/operation/GetOrderStatus

Param	Type	Required	Description
id	string	Yes	the 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

bitstamp.fetchOrder (id, symbol, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See

• https://www.bitstamp.net/api/#tag/Transactions-private/operation/GetUserTransactions
• https://www.bitstamp.net/api/#tag/Transactions-private/operation/GetUserTransactionsForMarket

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
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchMyTrades (symbol, since?, limit?, params?)

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

Kind: instance method of bitstamp
Returns: Array<object> - a list of funding rate structures

See: https://www.bitstamp.net/api/#tag/Market-info/operation/GetFundingRateHistory

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch the funding rate history for
since	int	No	timestamp in ms of the earliest funding rate to fetch
limit	int	No	the maximum amount of funding rate structures to fetch
params	object	No	extra parameters specific to the exchange API endpoint
params.until	int	No	timestamp in ms of the latest funding rate
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
params.subType	string	No	"linear" or "inverse"

bitstamp.fetchFundingRateHistory (symbol, since?, limit?, params?)

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

Kind: instance method of bitstamp
Returns: object - a list of transaction structure

See: https://www.bitstamp.net/api/#tag/Transactions-private/operation/GetUserTransactions

Param	Type	Required	Description
code	string	No	unified currency code for the currency of the deposit/withdrawals, default is undefined
since	int	No	timestamp in ms of the earliest deposit/withdrawal, default is undefined
limit	int	No	max number of deposit/withdrawals to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchDepositsWithdrawals (code?, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://www.bitstamp.net/api/#tag/Withdrawals/operation/GetWithdrawalRequests

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

bitstamp.fetchWithdrawals (code, since?, limit?, params?)

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of bitstamp
Returns: object - a ledger structure

See: https://www.bitstamp.net/api/#tag/Transactions-private/operation/GetUserTransactions

Param	Type	Required	Description
code	string	No	unified currency code, default is undefined
since	int	No	timestamp in ms of the earliest ledger entry, default is undefined
limit	int	No	max number of ledger entries to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchLedger (code?, since?, limit?, params?)

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of bitstamp
Returns: object - a funding rate structure

See: https://www.bitstamp.net/api/#tag/Market-info/operation/GetFundingRate

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.fetchFundingRate (symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See

• https://www.bitstamp.net/api/#tag/Orders/operation/GetAllOpenOrders
• https://www.bitstamp.net/api/#tag/Orders/operation/GetOpenOrdersForMarket

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

bitstamp.fetchOpenOrders (symbol, since?, limit?, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

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

See: https://www.bitstamp.net/api/#tag/Deposits/operation/GetCryptoDepositAddress

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

bitstamp.fetchDepositAddress (code, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of bitstamp
Returns: object - a transaction structure

See

• https://www.bitstamp.net/api/#tag/Withdrawals/operation/RequestFiatWithdrawal
• https://www.bitstamp.net/api/#tag/Withdrawals/operation/RequestCryptoWithdrawal

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	the amount to withdraw
address	string	Yes	the address to withdraw to
tag	string	Yes
params	object	No	extra parameters specific to the exchange API endpoint

bitstamp.withdraw (code, amount, address, tag, params?)

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of bitstamp
Returns: object - a transfer structure

See

• https://www.bitstamp.net/api/#tag/Sub-account/operation/TransferFromMainToSub
• https://www.bitstamp.net/api/#tag/Sub-account/operation/TransferFromSubToMain

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

bitstamp.transfer (code, amount, fromAccount, toAccount, params?)

watchOrderBook{docsify-ignore}

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

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

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

bitstamp.watchOrderBook (symbol, limit?, params?)

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

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

bitstamp.watchTrades (symbol, since?, limit?, params?)

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

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

bitstamp.watchOrders (symbol, since?, limit?, params?)