Skip to main content

One movement of cash on your account from trading: an order filling (type: order) or a position being paid out at settlement (type: settlement). One flat object for both: order is present only on an order transaction and settlement only on a settlement transaction. Money is in dollars; timestamps are epoch milliseconds.

id
string
required

The transaction's id, prefixed tx_.

Example:

"tx_6aedec66e2b7c4a9f0d18e53b6a2c7f4"

type
enum<string>
required

What moved the cash. order: an order filled, or a fill was later voided and reversed; order holds the order. settlement: the market settled and your position was paid out; settlement holds the record. A position that settles worthless pays nothing and has no transaction.

Available options:
order,
settlement
Example:

"order"

effect
enum<string>
required

Which way the cash moved. debit: taken from your cash (a buy that filled, or the reversal of a voided sale). credit: added to your cash (a sale that filled, a settlement payout, or the refund of a voided buy). Always credit on a settlement.

Available options:
debit,
credit
Example:

"debit"

amount
number
required

How much cash moved, in dollars, always positive; effect gives the direction. A filled buy is what it cost you including the fee (the order's fill_cost_plus_fees); a filled sale is what you received after the fee (proceeds_minus_fees); a settlement is the payout (normally settlement.amount).

Example:

5.97

title
string
required

A short label for the movement, for display: Markets - Bought, Markets - Sold, Markets - Settlement, Markets - Trade Voided Refund (a voided buy refunded) or Markets - Trade Voided Reversal (a voided sale taken back).

Example:

"Markets - Bought"

market_title
string
required

The game, market and side the transaction was on, ready to display, such as KC @ BUF • Chiefs to win or KC @ BUF • Over 47.5 points. On a settlement the side is the one the position held. An empty string when Splash could not build it.

Example:

"KC @ BUF • Chiefs to win"

created_at
integer<int64>
required

When the cash moved. Epoch milliseconds. Transactions are listed newest first by this, and from and to filter on it.

Example:

1793977446412

market
Market · object
required

The market the transaction was on, as it is now rather than as it was when the cash moved.

Example:
order
Order · object

The order, as Get an order returns it without its market. Present only when type is order.

Example:
settlement
Settlement · object

The settlement record. Present only when type is settlement.

Example: