> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trusset.org/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Security Status
> Read on-chain registration, the EIP-712 domain, and a wallet’s tradable balances
Returns everything a client needs to build and sign an order for this book: the security's live registration state, the exact EIP-712 domain and type definitions the custody contract expects, and, when you name a wallet, that wallet's tradable balances and its settlement asset allowance.
Use it before [Prepare Order](/endpoints/external-securities-trading/prepare-order) if you want to build the typed data yourself, and to show a trader what they can actually trade.
## Path Parameters
Order book ID.
## Query Parameters
Wallet to report balances for. Omit for the registration and domain data only.
## Response Fields
Order book ID.
Custody contract the book settles through.
Security token.
Settlement asset.
Identifier recorded on the book.
Security token decimals.
Settlement asset decimals.
Wallet authorized to sign settlements.
Live state read from the custody contract.
Security admin recorded at registration.
Identifier as a readable string.
The same identifier as the raw 32-byte value.
One whole unit of the security, in base units.
Whether the security is registered.
Whether the issuer still permits venue trading.
`name` is `TRexCustody`, `version` is `1`, `chainId` is your instance's chain, and `verifyingContract` is the custody contract.
The `Order` struct: `trader` and `token` and `quote` as addresses, `isBuy` as a bool, `quantity` and `price` as uint256, `expiry` and `nonce` as uint64, and `salt` as bytes32, in that order.
Present only when `userAddress` was supplied.
Security balances, in the security's base units, carrying `total`, `locked`, `onChainAvailable`, `reserved` and `available`.
Settlement asset balances, same shape, in the asset's base units.
Present only when `userAddress` was supplied. What the wallet has approved the custody contract to spend of the settlement asset, in base units.
## Reading the balances
`onChainAvailable` is what the contract reports. `reserved` is what this venue has committed to the wallet's own resting orders. `available` is the difference, and is the number an order is checked against.
For the settlement asset, the contract's available figure is already the lesser of balance and allowance, so a wallet with plenty of tokens but no approval reads as zero. Raise it with [Approve Settlement Asset](/endpoints/external-securities-trading/approve-quote-asset).
A balance read that fails answers with zeros rather than an error. Treat an unexpected zero as suspect if the wallet is known to be funded, and check [Get Trade Readiness](/endpoints/external-securities-trading/get-trade-readiness), which does surface a chain failure explicitly.
```bash cURL theme={null}
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001/security?userAddress=0xabc7f1093d5e26b804a1c3f78de025916b47c0d3" \
-H "X-API-Key: trusset_your_key_here"
```
```typescript TypeScript theme={null}
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}/security?userAddress=${address}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
const signature = await signer._signTypedData(data.eip712.domain, data.eip712.types, order);
```
```json Response theme={null}
{
"success": true,
"data": {
"orderBookId": "clx_ob_extsec_001",
"custodyContract": "0x489aee4ae9546081d55848f157e03192e826988c",
"tokenAddress": "0x51f2b9d0e77c4a1b83ce6d4a9271e5f3a0c8b912",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"underlyingIdentifier": "CH0012032048",
"baseDecimals": 18,
"quoteDecimals": 6,
"settlementOperator": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab",
"security": {
"admin": "0x7712db30a7b4ffd9c445793089118b60e56d752a",
"isin": "CH0012032048",
"isinRaw": "0x4348303031323033323034380000000000000000000000000000000000000000",
"baseUnit": "1000000000000000000",
"registered": true,
"active": true
},
"eip712": {
"domain": {
"name": "TRexCustody",
"version": "1",
"chainId": 11155111,
"verifyingContract": "0x489AeE4ae9546081d55848F157E03192e826988c"
},
"types": {
"Order": [
{ "name": "trader", "type": "address" },
{ "name": "token", "type": "address" },
{ "name": "quote", "type": "address" },
{ "name": "isBuy", "type": "bool" },
{ "name": "quantity", "type": "uint256" },
{ "name": "price", "type": "uint256" },
{ "name": "expiry", "type": "uint64" },
{ "name": "nonce", "type": "uint64" },
{ "name": "salt", "type": "bytes32" }
]
}
},
"balances": {
"base": {
"total": "500000000000000000000",
"locked": "0",
"onChainAvailable": "500000000000000000000",
"reserved": "20000000000000000000",
"available": "480000000000000000000"
},
"quote": {
"total": "100000000000",
"locked": "0",
"onChainAvailable": "50000000000",
"reserved": "0",
"available": "50000000000"
}
},
"quoteAllowance": "50000000000"
}
}
```
## Error Codes
| Code | HTTP | Cause |
| ---------------------- | ----- | ------------------------------------------------------------------- |
| `VALIDATION_ERROR` | `400` | `userAddress` is not a valid address |
| `ORDER_BOOK_NOT_FOUND` | `404` | No such external securities book on this instance, and not imported |
| `CHAIN_UNAVAILABLE` | `502` | The custody contract could not be read |
| `SERVICE_NOT_ENABLED` | `403` | The Trading service is not enabled on this instance |