Please Remember...
This is a fictional example and not real documentation. The purpose is to demonstrate my technical writing.
← burn token | api reference
API Reference: Check Token Balance
- Description: Retrieves the token balance of a specific wallet for a given asset.
- Method:
GET - Endpoint:
/api/tokens/balance - How-To: How to Check Token Balance
- Explanation: Token Lifecycle in Practice: Balance Check
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
asset_id |
String | ✅ | ID of the asset to query |
wallet_address |
String | ✅ | Wallet to check balance for |
Example Request
GET /api/tokens/balance?asset_id=UKGILT2030&wallet_address=0xDEF456...
Success Response
{
"asset_id": "UKGILT2030",
"wallet_address": "0xDEF456...",
"balance": 100
}
Error Responses
| Status Code | Error Code | Message |
|---|---|---|
| 400 | MISSING_QUERY_PARAM | Asset ID or wallet address missing |
| 404 | WALLET_NOT_FOUND | Wallet address does not exist |
| 500 | INTERNAL_ERROR | Unexpected server error |
What comes next?
Related Reading
- Post-Trade Automation: Learn about post-trade automation and how it compares with traditional post-trade workflows.
- Token Lifecycle: Learn how tokens are minted, transferred, queried, and burned throughout their lifecycle.
- How-To Guides: Step-by-step examples with code snippets for each major token operation.
- Glossary of Key Concepts: Definitions and explanations of common terminology used throughout the docs.