Sign in
banking.v1.BookService

SetBookPolicy

Changed on

Replace the allocation's trading terms (AllocationManage). Closing the book (book_open = false) stops new orders; resting ones stay and may still be cancelled.

post/banking.v1.BookService/SetBookPolicy

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

servicestring
book_openboolean
taker_fee_bpsinteger

0..10000

price_tickstring

decimal USDT, > 0; empty = 0.01

lot_sizestring

decimal units, > 0; empty = 0.0001

market_slippage_bpsinteger

0..10000; how far past the best quote a market order may fill

allow_unbacked_tradingboolean

The operator's acknowledgement that the book may trade units the fund holds no cash for (Allocation.backing = in_kind): a buyer pays cash for a claim on an asset held in kind and cannot redeem it. Required to open the book on an in_kind product, and checked again on every order — the backing can flip after the book opened (the first in-kind mint). Harmless on a cash product. The terminal shows buyers a notice when set.

Response

Success

servicestring
book_openboolean
taker_fee_bpsinteger
price_tickstring

decimal USDT

lot_sizestring

decimal units

market_slippage_bpsinteger
allow_unbacked_tradingboolean

See SetBookPolicyRequest.allow_unbacked_trading. When true the terminal tells buyers the units are not backed by fund cash and cannot be redeemed — the book is their only exit.

Changes

  • 0fee0a054615Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 174e58925b8fRevision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status