Get All Transactions
GET
https://api.sfox.com/v1/account/transactions
Retrieve your transaction history, including trades and transfers. It returns an array of objects, each of which has details for each individual transaction.
Rate Limit: 1 request per 10 seconds
Receive real-time trade, order, and balance updates using the sFOX WebSocket API. Click here for details.
Query Parameters
from
timestamp
Start date for your query. Results will include transactions that occurred after this date. Unix timestamp in ms. Default: utcnow - 24hrs
to
timestamp
End date for your query. Results will include transactions that occurred before this date. Unix timestamp in ms. Default: utcnow
limit
int
Maximum number of results to be returned by the request. Default: 250. Maximum: 1000
after
int
Pagination parameter. Return results that occurred after (newer) than the specified ID (id
from response body).
Use this parameter when you want to retrieve only new transactions from a previous request.
offset
int
Pagination parameter. Return results that occurred before (older) than the results from a previous request.
Specify the number of entries you've already had returned to you to get the next batch. e.g. If you retrieved 500
results in your previous request and you want the next 500
, set the offset to 501
.
types
string
Filter by transaction type. To filter by more than one type, separate each type with a comma. Possible values: charge
, deposit
, withdraw
, credit
, buy
, sell
pending
boolean
Specify whether the results should include transactions that are NOT completed (Done
). e.g. pending deposits or withdrawals. Only applicable to deposit
and withdraw
types
. Default: false
Response Body
id
sFOX-generated transaction ID. Use for after
pagination.
AtxId
Account transaction ID. An sFOX-generated ID specifically for deposit, withdrawal, credit, or charge transactions.
order_id
sFOX-generated ID of the order that this transaction is associated with, if applicable.
client_order_id
The optional ID that you specified when placing an order
trade_id
sFOX-generated ID of the trade, if applicable.
day
The timestamp of the transaction, in ISO8601 format
action
The action name of this transaction (“Deposit”, “Withdraw”, “Buy”, “Sell”, "Credit", "Charge")
currency
The base currency of the transaction
memo
The optional memo you specified for a withdrawal transaction
amount
The transacted amount of the currency
net_proceeds
Net amount after fees
price
Price per unit of the currency
fees
Fee paid in terms of the currency
status
The current transaction status
hold_expires
The expiration date of a hold on this transaction, if applicable
tx_hash
The transaction hash, if applicable (applicable to crypto deposits and withdrawals)
algo_name
The algorithm used to execute the transaction, if the transaction is an order
algo_id
The ID associated with the algorithm
account_balance
Your balance of the currency
after the transaction
AccountTransferFee
Fee paid in terms of the currency
for deposit or withdrawal transactions
Description
A description of the transaction. For crypto deposits, this is the sender address. For crypto withdrawals this is the destination address
added_by_user_email
The username/email address of the user who initiated this transaction
symbol
The currency pair of the transaction for trades (action
= Buy
or Sell
)
timestamp
The UNIX timestamp of the transaction in milliseconds
Transaction Statuses
The following table describes the possible Status Codes returned from this request.
These Status Codes are only applicable to deposit and withdrawal transactions. Other transaction types will always be returned with status = Done
Started
Transaction initiated
Approval Required
Deposits: N/A
Withdrawals: Approval is required before the transaction will be initiated
Processing Automatic withdrawal
Deposits: N/A
Withdrawals: Transaction is being broadcast
Confirmed
Deposits: Transaction has been received. It is not available yet but will be shortly
Withdrawals: Transaction has been approved. It has not been sent yet but will be shortly
Done
Deposits: Transaction is complete and available to you
Withdrawals: Transaction is complete
Canceled
Transaction has been canceled
Admin Hold, Pending Further Review
Transaction was flagged for review. Contact support@sfox.com for more information
Responses
Example Request
Last updated