Skip to content

Please Remember...

This is a fictional example and not real documentation. The purpose is to demonstrate my technical writing.

← how to check a token balance | api reference

API Overview

Welcome to the ABC-Labs Tokenisation API. This guide introduces the structure and logic of the API documentation, helping you quickly locate what you need.

API Versions

  • Latest API version: v1.1.0
  • See our Release Notes for latest updates.

What You Can Do with the API

  • Mint tokens to represent real-world assets
  • Transfer tokens between wallets
  • Burn tokens once assets are settled or redeemed
  • Check wallet balances

How the Documentation is Structured

Each API endpoint is described in its own dedicated page, following a consistent structure:

1. Header Summary

Quick summary of:

  • Brief Description
  • Method (e.g., POST, GET)
  • Endpoint path
  • Relevant How-To Links

2. Request Parameters

A table outlining:

  • Parameter name
  • Type (String, Number, etc.)
  • Whether it's required
  • What it does
Example:

| Field         | Type   | Required | Description           |
|---------------|--------|----------|-----------------------|
| `asset_id`    | String | ✅       | Token identifier      |
| `amount`      | Number | ✅       | Number of tokens      |

3. Example Requests & Responses

Code blocks to show:

  • Example request payload or query
  • Example success response (JSON)
  • Format varies (json, bash, etc.)

4. Error Handling

A table of known error responses including:

  • Status code
  • Error code (machine-friendly)
  • Message (human-readable)
Example:
| Status Code | Error Code        | Message                       |
|-------------|-------------------|-------------------------------|
| 400         | INVALID_INPUT     | Missing required parameters   |
  • Start with Examples: See the How-To Guides if you prefer learning by doing.
  • Use Search: Look up keywords like "mint", "burn", or "balance".
  • Understand the Lifecycle: Read Token Lifecycle for full context.
  • Understand Post-Trade Automation: Read the explanation guide on what post-trade automation is and how it fits in with traditional post-trade workflows.

Base URL

All API requests use the following base URL:

https://api.abc-labs.com

What comes next?

  • 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.