Skip to main content
POST
clearinghouseState

Authorizations

X-API-KEY
string
header
required

API key to access the API (Optional)

Query Parameters

chainId
enum<number>
default:999
required

Unique identifier for a blockchain network.

Available options:
999,
998
Example:

999

provider
enum<string>

Specify which provider to use. The project's provider priority list is used by default if no providers are selected. (Priority list can be managed on Uniblock's dashboard)

Available options:
Alchemy,
Dwellir,
Chainstack,
Covalent

Body

application/json
type
enum<string>
default:clearinghouseState
required
Available options:
clearinghouseState
Example:

"clearinghouseState"

user
string
required

The account address to query (0x-prefixed).

Example:

"0x000000000000000000000000000000000000dEaD"

Response

200 - application/json

Successful response.

marginSummary
object
required
crossMarginSummary
object
required
crossMaintenanceMarginUsed
string
required
Example:

"0.0"

withdrawable
string
required
Example:

"0.0"

assetPositions
object[]
required

Open perpetual positions. Each entry wraps the position under a type (e.g. oneWay) and a position object (coin, size, leverage, PnL).

time
number
required
Example:

1783650284938