> ## Documentation Index > Fetch the complete documentation index at: https://docs.brickken.com/llms.txt > Use this file to discover all available pages before exploring further. # Get STO Balance > **Description:** This endpoint retrieves balance details and current status for a Security Token Offering (STO). **Headers:** - `x-api-key`: `YOUR_API_KEY` **Query Parameters:** - `tokenSymbol` (string): The symbol of the token. - `id` (string, format: uuid): The unique identifier of the STO. Retrieves the balance of an STO. ## Query Parameters * `tokenSymbol` (required): Token symbol * `id` (required): STO ID ## Example ```bash theme={null} curl --request GET \ --url 'https://api.sandbox.brickken.com/get-sto-balance?tokenSymbol=EXMPL&id=123' \ --header 'x-api-key: YOUR_API_KEY' ``` ## Response ```json theme={null} { "balance": "50000" } ``` ## OpenAPI ````yaml GET /get-sto-balance openapi: 3.1.0 info: title: Brickken API V2 description: >- Welcome to the Brickken API documentation. This API allows customers to create and manage tokenization processes, including creating new tokenizations, minting/burning/transferring tokens, whitelisting users, manage tokens approvals. This documentation provides detailed information on how to use the API, including the necessary endpoints, request formats, and expected responses.
**Authentication**All API requests require an API key for authentication. Include your API key in the `x-api-key` header of each request:
```
      x-api-key: YOUR_API_KEY
    ```
Ensure that your API key is kept secure and not shared publicly. A common parameter for all requests is the `signerAddress`. Such address MUST be whitelisted in our factory. To whitelist an address and/or request an API key either for sandbox/production environment please contact with: support@brickken.com. Once a `signerAddress` performs a `newTokenization` we refer to that address as the tokenizer. The tokenizer will be the only one allowed to mint such token, distribute dividends on such token and whitelist/blacklist investors of such token. Regarding actions like transferring tokens or burning tokens, the `signerAddress` can be any user and not only the tokenizer.
**Supported Networks & Addresses**
Sepolia (sandbox environment only)
```
      Chain Id: "aa36a7"
      Factory Address: "0x933ABAA95a7Fd0Bc683bDe2adB89f4C5EA64897b"
      BKN Address: "0x97a13487f889dc770Ac925Be2d3b6c833FA7746a"
      USDT Address: "0x28d2B01854D0aBec267a3DDcad9163580E6E8604"
      USDC Address: "0xb10cE8e28aEb1ae27b968Fb3bfed2FD7dd52daCb"
    ```
Base Sepolia (sandbox / testing)
```
      Chain Id: "84532" (hex "14a34")
      x402 USDC (Circle, EIP-3009): "0x036CbD53842c5426634e7929541eC2318f3dCF7e"
      ERC-8004 Identity Registry: "0x8004A818BFB912233c491871b3d84c89A494BD9e"
      ERC-8004 Reputation Registry: "0x8004B663056A597Dffe9eCcC1965A193B7388713"
    ```
Ethereum mainnet (production environment only)
```
      Chain Id: "1"
      Factory Address: "0x91af681C85Ca98Efc5D69C1B62E6F435030969Db"
      BKN Address: "0x0A638F07ACc6969abF392bB009f216D22aDEa36d"
      USDT Address: "0xdac17f958d2ee523a2206206994597c13d831ec7"
      USDC Address: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
    ```
Base mainnet (production environment only)
```
      Chain Id: "2105"
      Factory Address: "0x278D7bdc2451B0Fa4087A68ce084a86cB91D4d83"
      BKN Address: "0xddB293BB5C5258F7484A94a0fBd5c8B2F6E4e376"
      USDT Address: N/A
      USDC Address: "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
    ```
BNB Smart Chain mainnet (production environment only)
```
      Chain Id: "38"
      Factory Address: "0xCe4529Fe88df480BD777d3e32dfD7032e6C685ff"
      BKN Address: "0x0e28bC9B03971E95acF9ae1326E51ecF9C55B498"
      USDT Address: "0x55d398326f99059fF775485246999027B3197955"
      USDC Address: "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d"
    ```
Avalance C Chain mainnet (production environment only)
```
      Chain Id: "a86a"
      Factory Address: "0xc6c230FA8F40022dE997727436Fae01caAbcDe61"
      BKN Address: "0xd44E4Dc8bdF7C1c62CfDBb182022097BA42Ac6bC"
      USDT Address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7"
      USDC Address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"
    ```
**Usage Workflow**
1. **Prepare Transactions:**- Use the `POST /prepare-transactions` endpoint with the desired method (e.g., `newTokenization`, `mintToken`, etc...) to prepare the transaction(s). - The response will include an array of unsigned transactions that needs to be signed.
**Example Of An Endpoint Response:**```json { "transactions": [ { "from": "0xSignerAddress", "to": "0xTargetAddress", "value": { "type": "BigNumber", "hex": "0x00" }, "nonce": 1, "chainId": 11155111, "data": "0x...", "type": 2, "maxPriorityFeePerGas": { "type": "BigNumber", "hex": "0x..." }, "maxFeePerGas": { "type": "BigNumber", "hex": "0x..." }, "gasLimit": { "type": "BigNumber", "hex": "0x..." } } ] } ```
2. **Sign the Transactions:**- Use your preferred method or wallet to sign the transaction data provided in the response. - Ensure that the signer address matches the `signerAddress` provided in the initial request.
**Example Of signing a transaction with typescript and `ethers-js`:**```typescript const tx = {...} // One of the object in the array returned by the `/prepare-transactions` endpoint const privateKey = process.env.PRIVATE_KEY; const wallet = new ethers.Wallet(privateKey); const signedTx = await wallet.signTransaction(tx); console.log('Signed Transaction:', signedTx); ```
**NOTE:** Be sure to have enough funds in the signer wallet to cover for the transaction cost
3. **Submit Signed Transactions:**- Use the `POST /send-transactions` endpoint to submit the signed transaction(s) along with the required parameters. - The API will process the transactions, send them to the blockchain, and update the Brickken database accordingly.
4. **Check Transaction Status:**- Use the `GET /get-transaction-status` endpoint to check the status of your transaction. - Provide either the on-chain transaction hash (`hash`) or the internal transaction ID (`txId`) to retrieve the status.
**Environments**The API is available in several environments for testing and production purposes:- Sandbox: `https://api.sandbox.brickken.com/` - Master (Production): `https://api.brickken.com/`
The API also exposes x402scan discovery facade endpoints under /x402/... The public discovery target is https://api.brickken.com, with /.well-known/x402 returning resource URLs and /openapi.json returning the generated OpenAPI 3.1 document. version: 2.0.0 servers: - url: https://api.sandbox.brickken.com description: Sandbox Environment - url: https://api.brickken.com description: Production Environment security: - apiKeyAuth: [] paths: /get-sto-balance: get: tags: - Endpoints summary: Get STO balance and status information description: >- **Description:** This endpoint retrieves balance details and current status for a Security Token Offering (STO). **Headers:** - `x-api-key`: `YOUR_API_KEY` **Query Parameters:** - `tokenSymbol` (string): The symbol of the token. - `id` (string, format: uuid): The unique identifier of the STO. parameters: - name: tokenSymbol in: query required: true schema: type: string description: The symbol of the token. - name: id in: query required: true schema: type: string format: uuid description: The unique identifier (UUID) of the STO. responses: '200': description: Successful response - STO balance details retrieved content: application/json: schema: type: object description: Represents the balance and status details of an STO. properties: uuid: type: string format: uuid description: Unique identifier of the STO. example: a1b2c3d4-e5f6-7890-1234-567890abcdef name: type: string description: Name of the STO. example: Project Phoenix STO companyName: type: string description: Name of the company issuing the STO. example: Phoenix Innovations Inc. status: type: string description: >- Current status of the STO (e.g., ACTIVE, PAUSED, COMPLETED). example: ACTIVE tokenAmount: type: string description: Total amount of tokens offered in the STO (as a string). example: '5000000' hardCap: type: string description: The hard cap funding goal (as a string). example: '2500000' softCap: type: string description: The soft cap funding goal (as a string). example: '500000' minInvestment: type: string description: Minimum required investment per participant (as a string). example: '200' maxInvestment: type: string description: Maximum allowed investment per participant (as a string). example: '25000' startDate: type: string format: date-time description: The STO start date and time in ISO 8601 format. example: '2025-05-01T09:00:00.000Z' endDate: type: string format: date-time description: The STO end date and time in ISO 8601 format. example: '2025-08-01T23:59:59.000Z' tokenPrice: type: string description: Price per token (as a string). example: '0.75' tokenSymbol: type: string description: Symbol for the token being offered. example: PHNX currentAmountRaised: type: string description: The amount currently raised in the STO (as a string). example: '875320.50' availableAmount: type: string description: >- The amount of tokens still available for sale (as a string). example: '4124679.33' required: - uuid - name - companyName - status - tokenAmount - hardCap - softCap - minInvestment - maxInvestment - startDate - endDate - tokenPrice - tokenSymbol - currentAmountRaised - availableAmount security: - apiKeyAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key ````