Skip to main content
GET
Ended positions

Query Parameters

owner
string

Return only the rows of this wallet. Give the wallet as base58 or as 64 hex characters. Any other value matches nothing: the page is empty and filters.owner repeats the value.

market
string

Return only the rows of this market. Give the market account address as 64 hex characters.

phase
enum<string>

Return only the positions in this phase. Any other phase gets 400.

Available options:
settled,
voided
signature
string

Return only the position that this transaction touched. Give the signature in base58.

beforeSlot
integer

Return only the rows before this slot. To get the next page, send nextBeforeSlot from the previous page. Unit: slots.

Required range: x >= 0
limit
integer
default:50

The number of rows in the page. The server reads a value above 100 as 100.

Required range: 1 <= x <= 100

Response

A page of ended positions.

A page of positions that have ended, newest first.

asOf
object
required

How fresh the archive is at the time of this response.

tier
enum<string>
required

The access tier that answered. It is public for a caller without a key.

Available options:
public
window
object
required

The time window of a per-transaction route.

filters
object
required

The filters of this request, as sent. A filter that was not sent is null.

sampleSize
integer
required

The number of rows in this page. Unit: rows.

totalMatching
integer
required

The number of rows in the window that match the filters. Unit: rows.

nextBeforeSlot
integer | null
required

Send this value as beforeSlot to get the next page. Null on the last page. Unit: slots.

positions
object[]
required

The positions, newest first.

note
string

A statement, in words: the phase is the last one that the archive saw.