Skip to main content

Get Registered DeepBook Pools

Retrieve a list of all DeepBook trading pools that are enabled for margin trading, along with their risk parameters and liquidation configurations. This endpoint shows which trading pairs support leveraged positions.

Endpoint

GET /deepbook-margin/registered-deepbook-pools

Use Cases

  • Pool Discovery — Find which DeepBook pools support margin trading
  • Risk Parameter Display — Show liquidation thresholds and risk ratios to users
  • Trading Interface Configuration — Configure leverage options based on pool settings
  • Liquidation Bot Setup — Get reward parameters for liquidation strategies

Parameters

Query Parameters

ParameterTypeRequiredDescription
marginPoolIdstringNoFilter by margin pool ID (searches in both base and quote margin pool IDs)
api-keystringYesYour Surflux API key for authentication

Response

Returns an array of registered DeepBook pool objects. Each pool contains:

FieldTypeDescription
pool_idstringDeepBook trading pool ID
base_margin_pool_idstringMargin pool ID for the base asset
quote_margin_pool_idstringMargin pool ID for the quote asset
min_withdraw_risk_rationumberMinimum risk ratio to withdraw collateral
min_borrow_risk_rationumberMinimum risk ratio to take new loans
liquidation_risk_rationumberRisk ratio below which positions can be liquidated
target_liquidation_risk_rationumberTarget risk ratio after partial liquidation
user_liquidation_rewardnumberReward percentage for liquidators
pool_liquidation_rewardnumberReward percentage for the margin pool
enabledbooleanWhether margin trading is currently enabled
extra_fieldsobject | nullAdditional pool metadata
checkpoint_idnumberCheckpoint when pool was last updated
digeststringTransaction digest of last update
onchain_timestampnumberOn-chain timestamp in milliseconds
created_atstringISO timestamp of registration
updated_atstringISO timestamp of last update