Skip to main content

userStarState Info Endpoint Method

Returns a user’s HIP-3 star venue approval state.

Updated on
Nov 10, 2026

The request is accepted on mainnet. HIP-3 star venue functionality is described as testnet-only in the upstream documentation. The mainnet example account has no recorded approvals.

Populated response format​

The official testnet API returns dexToState as an array of [dexName, state] tuples. These two response variants were captured on testnet; they do not establish mainnet star venue availability.

{
"dexToState": [
[
"ignp",
{ "isReduceOnly": false, "isBackstopLiquidatorDepositAllowed": true }
]
]
}

When a venue has removed a user's approval, its state can be null:

{ "dexToState": [["nimb", null]] }

Parameters

type
string
REQUIRED

Info request type.

user
string
REQUIRED

User address in 42-character hexadecimal format.

Returns

dexToState
array

Array of [dexName, state] tuples. dexName is the venue name. state is null for a removed approval, or an object with boolean isReduceOnly and isBackstopLiquidatorDepositAllowed fields. An account with no recorded approvals returns an empty array. Populated and null tuple states were verified on the official testnet API.

tuple
array

Each array element is a two-element tuple. The numbered entries below are array positions, not object keys.

0
string

[0] dexName. HIP-3 star venue name.

1
object|null

[1] state. Current approval flags for the venue, or null if the venue removed the user’s approval. Populated and null states were verified on the official testnet API.

isReduceOnly
boolean

Whether the user is restricted to reduce-only trading on this venue.

isBackstopLiquidatorDepositAllowed
boolean

Whether the user may deposit into this venue’s backstop liquidator.

Request
Response
1
{
2
"dexToState": []
3
}
1
{
2
"dexToState": []
3
}
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free