Skip to main content
GET
Returns the book’s access settings: the delivery mode, the buyer and seller gates, and how a refused wallet is onboarded. Name a wallet to learn whether it may buy and sell, and how it gets admitted if not. See Access module. The gates are read live from the custody contract for the book’s settlement operator, so the answer is what a settlement would enforce right now. Works on books you own and books you have imported.

Path Parameters

string
required
Order book ID.

Query Parameters

string
Wallet to check. Omit for the settings only.

Response Fields

object

Error Codes