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

Name

Type

Description

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

Key

Description

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

Status Code

Description

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

200

[
    {
        "id": 68029980111539,
        "AtxId": null,
        "order_id": "80000120662565",
        "client_order_id": "2013acd0-ea78-46c3-b2ac-ed4546f13182",
        "trade_id": "8848300113216138",
        "day": "2024-03-28T15:47:41.000Z",
        "action": "Sell",
        "currency": "usd",
        "memo": "",
        "amount": 71.26350189,
        "net_proceeds": 71.26350189,
        "price": 71299.1514729,
        "fees": 0.03564958,
        "status": "done",
        "hold_expires": "",
        "tx_hash": "",
        "algo_name": "Limit",
        "algo_id": "201",
        "account_balance": 3702.72950349,
        "AccountTransferFee": 0,
        "Description": "",
        "wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000",
        "added_by_user_email": "example@sfox.com",
        "symbol": "btc/usd",
        "IdempotencyId": null,
        "timestamp": 1711640861000
    },
    {
        "id": 68029980111538,
        "AtxId": null,
        "order_id": "80000120662565",
        "client_order_id": "2013acd0-ea78-46c3-b2ac-ed4546f13182",
        "trade_id": "8848300113216138",
        "day": "2024-03-28T15:47:41.000Z",
        "action": "Sell",
        "currency": "btc",
        "memo": "",
        "amount": -0.001,
        "net_proceeds": -0.001,
        "price": 71299.1514729,
        "fees": 0.03564958,
        "status": "done",
        "hold_expires": "",
        "tx_hash": "",
        "algo_name": "Limit",
        "algo_id": "201",
        "account_balance": 10.00216189,
        "AccountTransferFee": 0,
        "Description": "",
        "wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000",
        "added_by_user_email": "example@sfox.com",
        "symbol": "btc/usd",
        "IdempotencyId": null,
        "timestamp": 1711640861000
    },
    {
        "id": 68029980111501,
        "AtxId": 1670509823872833,
        "order_id": "",
        "client_order_id": "",
        "trade_id": "",
        "day": "2024-03-28T16:03:54.000Z",
        "action": "Credit",
        "currency": "dot",
        "memo": "",
        "amount": 0.0564958,
        "net_proceeds": 0.0564958,
        "price": 9.60559235,
        "fees": 0,
        "status": "done",
        "hold_expires": "",
        "tx_hash": "",
        "algo_name": "",
        "algo_id": "",
        "account_balance": 120.70980446,
        "AccountTransferFee": 0,
        "Description": "Staking Reward",
        "wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000",
        "added_by_user_email": "example@sfox.com",
        "symbol": null,
        "IdempotencyId": null,
        "timestamp": 1711641834000
    }
]

Example Request

curl -H 'Authorization: Bearer <API_TOKEN>' \ 
https://api.sfox.com/v1/account/transactions?limit=50

const axios = require('axios');

axios({
  method: 'get',
  url: 'https://api.sfox.com/v1/account/transactions',
  headers: {
    'Authorization': 'Bearer <API_KEY>'
  },
  params: {
   limit: 50
  }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});ja

import requests

data = requests.get(
  "https://api.sfox.com/v1/account/transactions",
  headers={
    "Authorization": "Bearer <API_KEY>",
  }
  params={
   "limit": 50
  }
)
print(data)

PreviousGet Portfolio Valuation NextIntroduction

Last updated 8 months ago