| Term | Meaning |
|---|---|
ack | The reply to a request. for names the request it answers. An ack to place_order means taken, not filled |
available (cash) | What a new buy can spend: your own cash, less what your orders spent and still hold. get_cash_balance_v2 answers it |
| Burn | CETs destroyed from the redemption wallet against shares a sell executed |
| CET | Convertible Entitlement Token: a token that stands for one share of a listed company |
| Execution | One fill of an order: a quantity at a price at a time. An order often fills in several. Listed in fills, and pushed as trade_updated |
externalRef | Your reference for an order, and its idempotency key: a reference an order already uses is refused, never duplicated, except that of an order the broker rejected |
| Memo | The text on a mint or burn: <externalRef>:<executedQty>:<traceId>. Written on the transaction on Solana only |
| Mint | CETs issued on chain to your registered wallet against shares a buy executed |
orderId | Securitize’s id for an order, returned in the ack. Every order message takes it |
| Push | A frame the server sends without a request: order_updated, trade_updated, mint_updated, burn_updated or cash_movement. It has no requestId |
| Read-only key | A key registered for reading only: its session gets every read and push, and its place_order and cancel_order answer NOT_PERMITTED |
| Redemption balance | What is yours in a CET’s redemption wallet: the transfers credited to you, less what your sells burned or hold. get_redemption_balance answers it for one CET and get_redemption_balances for all of them, and a sell for more than its available is refused |
| Redemption wallet | The Securitize wallet you send CETs to before selling the shares they stand for. One per CET, shared by every account that sells it, so a sell is checked against your redemption balance. get_redemption_address answers its address |
| Registered wallet | The wallet, registered with Securitize for your account, that receives the CETs minted against your buys |
regulatoryId | The broker’s id for an order, used in regulatory reporting. Joins the order to its trades, mints and burns |
requestId | Your id for a message, echoed on its reply |
| Sandbox | The test environment. Orders execute against a simulator that fills everything at once |
| Session | What a signed hello opens on one socket. One socket, one session, one account |
traceId on a mint or burn | The short base58 handle at the end of the memo. A business key that get_mints and get_burns take |
traceId on the envelope | Securitize’s id for an exchange. Quote it to support |
txHash | The hash of a mint or burn transaction on its chain. get_mints and get_burns take it |
| Underlying | The share a CET stands for, and what this API buys and sells |
Help
Glossary
The terms these docs use, in one place.