HTTP endpoints

Get position

Parameters

Parameter	Required	Type	Description
account	yes	string (hex)	Ethereum-style account address for the sub-account context.
instrumentId	yes	integer (int64)	Target instrument identifier.

Response fields

Parameter	Required	Type	Description
`positions`	no	object	—

Response example

A sample 200 JSON body is attached to this operation as an OpenAPI example (Mintlify shows it in the example panel, similar to other exchange API docs).

GET

/

position

Get position

curl --request GET \
  --url https://beta.rocketfi.io/position

{
  "positions": null
}

Path Parameters

account

string<hex>

required

Ethereum-style account address for the sub-account context. An Ethereum-style account address (20 bytes).

instrumentId

null | integer<int64>

required

Target instrument identifier. An instrument identifier (8-byte hash).

Required range: x >= 0

Response

200 - application/json

Positions by account

positions

object

Show child attributes

Get vault history### Parameters | Parameter | Required | Type | Description | | --------- | -------- | ---- | ----------- | | vault | yes | string (hex) | Vault address (required) | | user | yes | string (hex) | User address (optional) | | paginationData | yes | object | Pagination segment containing `pageNumber` and `pageSize` (serialized per gateway contract). | ### Response fields | Parameter | Required | Type | Description | | --------- | -------- | ---- | ----------- | | `history` | yes | object[] | View containing multiple vault history entries with human-readable values | | `history[].amount` | yes | string | Amount deposited or payout amount for withdrawals (human-readable) | | `history[].assetId` | yes | integer | — | | `history[].eventType` | yes | string | Type of vault history event | | `history[].round` | yes | integer (int64) | — | | `history[].shares` | yes | integer | — | | `history[].timestamp` | yes | integer (int64) | — | | `history[].txHash` | yes | string (hex) | Transaction hash | | `history[].user` | yes | string (hex) | User who deposited/withdrew | | `history[].vault` | yes | string (hex) | Vault address | | `pageNumber` | yes | integer | — | | `pageSize` | yes | integer | — | ### Response example A sample **`200`** JSON body is attached to this operation as an OpenAPI **example** (Mintlify shows it in the example panel, similar to other exchange API docs).

Get position

curl --request GET \
  --url https://beta.rocketfi.io/position

{
  "positions": null
}