Get transactions

Authorizations

X-Client-Secret

string

header

required

Contact Mesh to get client Secret

X-Client-Id

string

header

required

Contact Mesh to get client Id

Body

application/json

authToken

string

required

Auth token that allows connecting to the target institution

Minimum length: 1

type

enum<string>

required

Type of the institution to connect

Supported integrations:

Robinhood ETrade Alpaca WeBull Stash InteractiveBrokers Public Coinbase Kraken CoinbasePro CryptoCom Binance Gemini OkCoin KuCoin Etoro CexIo BinanceInternational Bitstamp GateIo Okx BitFlyer Coinlist Huobi Bitfinex KrakenDirect Vanguard BinanceInternationalDirect Bybit CoinbasePrime RobinhoodConnect

Available options:

robinhood,

eTrade,

alpaca,

tdAmeritrade,

weBull,

stash,

interactiveBrokers,

public,

coinbase,

kraken,

coinbasePro,

cryptoCom,

openSea,

binanceUs,

gemini,

cryptocurrencyAddress,

cryptocurrencyWallet,

okCoin,

bittrex,

kuCoin,

etoro,

cexIo,

binanceInternational,

bitstamp,

gateIo,

acorns,

okx,

bitFlyer,

coinlist,

huobi,

bitfinex,

deFiWallet,

krakenDirect,

vanguard,

binanceInternationalDirect,

bitfinexDirect,

bybit,

paxos,

coinbasePrime,

btcTurkDirect,

kuCoinDirect,

okxOAuth,

paribuDirect,

robinhoodConnect,

blockchainCom,

bitsoDirect,

binanceConnect,

binanceOAuth,

revolutConnect,

binancePay,

bybitDirect

count

integer

Number of records to include in the response. <br /> Default: 100 <br /> Maximum: 250

cursor

string | null

The cursor to retrieve the next page of transactions. Providing it will cause the response to only return changes after this update. If this field is not provided, the history of transactions will be returned starting with the first-added transaction.

from

integer | null

Return orders created after this timestamp. If this field is not provided, orders will be returned according to the default of the institution.

statuses

enum<string>[] | null

Return orders of this statuses only. If this field is not provided, orders with all available statuses will be returned.

Available options:

unknown,

inProgress,

cancelled,

rejected,

failed,

success,

partiallyFilled,

expired

Response

200 - application/json

content

object

content.cursor

string | null

The cursor to retrieve the next page of transactions.

content.earliestTimestamp

integer

Earliest transaction timestamp.

content.total

integer

Total amount of records.

content.transactions

object[] | null

List of obtained transactions.

content.transactions.amount

number | null

Executed amount

content.transactions.assetType

enum<string>

Type of the traded asset

Available options:

equity,

cryptocurrency,

option,

nft

content.transactions.brokerType

enum<string>

Type of the integration

Available options:

robinhood,

eTrade,

alpaca,

tdAmeritrade,

weBull,

stash,

interactiveBrokers,

public,

coinbase,

kraken,

coinbasePro,

cryptoCom,

openSea,

binanceUs,

gemini,

cryptocurrencyAddress,

cryptocurrencyWallet,

okCoin,

bittrex,

kuCoin,

etoro,

cexIo,

binanceInternational,

bitstamp,

gateIo,

acorns,

okx,

bitFlyer,

coinlist,

huobi,

bitfinex,

deFiWallet,

krakenDirect,

vanguard,

binanceInternationalDirect,

bitfinexDirect,

bybit,

paxos,

coinbasePrime,

btcTurkDirect,

kuCoinDirect,

okxOAuth,

paribuDirect,

robinhoodConnect,

blockchainCom,

bitsoDirect,

binanceConnect,

binanceOAuth,

revolutConnect,

binancePay,

bybitDirect

content.transactions.createdTimestamp

integer

Unix timestamp in seconds indicating when the order was placed or the transaction was created

content.transactions.fee

number | null

Order Fee, taken by the financial institution

content.transactions.id

string | null

Transaction id, as provided by the institution

content.transactions.name

string | null

Name of the traded asset

content.transactions.optionDetails

object

Additional details for options

content.transactions.orderType

enum<string>

Type of the placed order

Available options:

unknown,

market,

limit,

stopLoss,

stopLimit,

takeProfit,

netDebit,

netCredit,

exercise

content.transactions.parentOrderId

string | null

Id of the parent order, applicable to some institutions

content.transactions.paymentSymbol

string | null

Fiat or cryptocurrency symbol used for payment. For transactions with types ConversionFrom or ConversionTo this field specifies the target symbol. For example, for ETH to BTC conversion, the transaction type is ConversionTo, the Symbol field is ETH and the PaymentSymbol is BTC

content.transactions.paymentType

enum<string>

Indicates if the payment was performed with fiat or crypto currency

Available options:

fiat,

cryptocurrency

content.transactions.price

number | null

Price of the unit

content.transactions.side

enum<string>

Side of the transaction

Available options:

unknown,

buy,

sell

content.transactions.status

enum<string>

Status of the transaction

Available options:

unknown,

inProgress,

cancelled,

rejected,

failed,

success,

partiallyFilled,

expired

content.transactions.statusDetails

string | null

Status text, as provided by the institution

content.transactions.symbol

string | null

Traded symbol

content.transactions.timeInForce

enum<string>

Time in force of the order: a value indicating how long the order remains active before it is executed or expires

Available options:

goodTillCanceled,

immediateOrCancel,

fillOrKill,

goodForDay,

postOnly,

unknown

content.transactions.transactionType

enum<string>

Type of the transaction

Available options:

order,

conversionTo,

conversionFrom,

ownAccountDeposit,

ownAccountWithdraw,

stake,

dividendReinvestment,

interest,

reward,

unknown,

conversionToFiat,

conversionFromFiat

content.transactions.updatedTimestamp

integer

Unix timestamp in seconds indicating when the transaction was last updated (e.g. executed)

content.transactions.value

number | null

Total value

displayMessage

string | null

User-friendly display message that can be presented to the end user

errorData

any | null

errorType

string | null

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

message

string | null

A message generated by the API

status

enum<string>

Available options:

ok,

serverFailure,

permissionDenied,

badRequest,

notFound,

conflict,

tooManyRequest,

locked,

unavailableForLegalReasons