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

# Dapp API

> API-key authenticated Brickken API for tokenization, STOs, security-token operations, and reads.

<img className="block dark:hidden" src="https://mintcdn.com/brickken/UYpLPKOSKNI6CnjX/images/hero-light.png?fit=max&auto=format&n=UYpLPKOSKNI6CnjX&q=85&s=81659380e5c01ec57ea5a664f8d129cc" alt="Hero Light" width="2064" height="1104" data-path="images/hero-light.png" />

<img className="hidden dark:block" src="https://mintcdn.com/brickken/UYpLPKOSKNI6CnjX/images/hero-dark.png?fit=max&auto=format&n=UYpLPKOSKNI6CnjX&q=85&s=25906a19d90f9e139a73a92f9a5d8a59" alt="Hero Dark" width="2064" height="1104" data-path="images/hero-dark.png" />

## Overview

The Brickken Dapp API is the API-key authenticated surface for tokenized asset workflows. Use it when your integration owns a Brickken API key and wants to prepare transactions for a wallet to sign, submit signed transactions, or read tokenization and STO data.

Use the [Agentic API](/api-reference/endpoint/agentic-methods-x402), [MCP](/mcp/introduction), or [CLI](/cli/introduction) for private-key based agentic flows.

## Base URLs

| Environment | Base URL                           |
| ----------- | ---------------------------------- |
| Sandbox     | `https://api.sandbox.brickken.com` |
| Production  | `https://api.brickken.com`         |

## Authentication

Send your API key in every request:

```http theme={null}
x-api-key: YOUR_BRICKKEN_API_KEY
```

Request a key from `tech@brickken.com` with the email tied to your Brickken account.

<Card title="Postman Collection" icon="download" href="/api-reference/postman">
  Download the official Postman collection and environments to explore every endpoint with ready-to-run example requests.
</Card>

## Transaction Flow

Most write operations use the same three-step flow:

1. **Prepare** unsigned transactions with `POST /prepare-transactions`.
2. **Sign** every returned transaction with the wallet matching `signerAddress`.
3. **Send** the signed payloads with `POST /send-transactions`, then poll `GET /get-transaction-status`.

```bash theme={null}
curl --request POST 'https://api.sandbox.brickken.com/prepare-transactions' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_BRICKKEN_API_KEY' \
  --data '{
    "chainId": "11155111",
    "method": "newTokenization",
    "tokenizerEmail": "issuer@example.com",
    "signerAddress": "0xYourWallet",
    "tokenName": "Example Asset",
    "tokenSymbol": "EXMPL",
    "tokenType": "RWA_TOKEN",
    "supplyCap": "1000000",
    "url": "https://example.com/token-docs"
  }'
```

The response includes `txId` and `transactions`. Sign the transaction or transactions locally, then send them:

```bash theme={null}
curl --request POST 'https://api.sandbox.brickken.com/send-transactions' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_BRICKKEN_API_KEY' \
  --data '{
    "txId": "0xPreparedTransactionId",
    "signedTransactions": ["0xSignedRawTransaction"]
  }'
```

## Write Endpoints

| Endpoint                                          | Purpose                                                                        |
| ------------------------------------------------- | ------------------------------------------------------------------------------ |
| `POST /prepare-transactions`                      | Prepare any supported transaction method by passing `method` in the JSON body. |
| `POST /prepare-transactions/newTokenization`      | Prepare a new tokenized asset.                                                 |
| `POST /prepare-transactions/mintToken`            | Prepare token minting.                                                         |
| `POST /prepare-transactions/whitelist`            | Prepare whitelist updates.                                                     |
| `POST /prepare-transactions/burnToken`            | Prepare token burning.                                                         |
| `POST /prepare-transactions/transferFrom`         | Prepare allowance-based token transfer.                                        |
| `POST /prepare-transactions/transferTo`           | Prepare direct token transfer.                                                 |
| `POST /prepare-transactions/approve`              | Prepare allowance approval.                                                    |
| `POST /prepare-transactions/dividendDistribution` | Prepare dividend distribution.                                                 |
| `POST /prepare-transactions/newSto`               | Prepare a Security Token Offering.                                             |
| `POST /prepare-transactions/newInvest`            | Prepare an STO investment.                                                     |
| `POST /prepare-transactions/claimTokens`          | Prepare token claims from an STO.                                              |
| `POST /prepare-transactions/closeOffer`           | Prepare an STO close operation.                                                |
| `POST /send-transactions`                         | Submit signed transactions returned by prepare.                                |
| `PATCH /patch-token-docs`                         | Update token documentation and branding files.                                 |

## Supported Methods

| Area         | `method` values                                                                                                           |
| ------------ | ------------------------------------------------------------------------------------------------------------------------- |
| Tokenization | `newTokenization`, `mintToken`, `whitelist`, `burnToken`, `transferFrom`, `transferTo`, `approve`, `dividendDistribution` |
| STOs         | `newSto`, `newInvest`, `claimTokens`, `closeOffer`                                                                        |

## Read Endpoints

| Endpoint                         | Purpose                                                  |
| -------------------------------- | -------------------------------------------------------- |
| `GET /get-network-info`          | Read chain metadata and supported network configuration. |
| `GET /get-token-info`            | Read token information by symbol or chain.               |
| `GET /get-tokenizer-info`        | Read tokenizer account information.                      |
| `GET /get-stos`                  | List STOs for a token.                                   |
| `GET /get-sto-by-id`             | Read one STO by ID.                                      |
| `GET /get-investments-by-sto-id` | List investments for one STO.                            |
| `GET /get-investor-info`         | Read investor status by token and email.                 |
| `GET /get-allowance`             | Read allowance between owner and spender.                |
| `GET /get-balance-whitelist`     | Read investor balance and whitelist status.              |
| `GET /get-whitelist-status`      | Check whether an investor wallet is whitelisted.         |
| `GET /get-sto-balance`           | Read STO balance and status.                             |
| `GET /get-dividend-distribution` | Read dividend distribution information.                  |
| `GET /get-transaction-status`    | Poll a submitted blockchain transaction.                 |

```bash theme={null}
curl --request GET \
  'https://api.sandbox.brickken.com/get-network-info?chainId=11155111' \
  --header 'x-api-key: YOUR_BRICKKEN_API_KEY'
```

## Networks

Pass `chainId` as decimal or hex. Client tooling normalizes common values.

| Network              | Decimal    | Hex        |
| -------------------- | ---------- | ---------- |
| Ethereum mainnet     | `1`        | `0x1`      |
| Base mainnet         | `8453`     | `0x2105`   |
| BNB Smart Chain      | `56`       | `0x38`     |
| Polygon mainnet      | `137`      | `0x89`     |
| Sepolia testnet      | `11155111` | `0xaa36a7` |
| Polygon Amoy testnet | `80002`    | `0x13882`  |

<Warning>
  Prepared transactions are on-chain actions. Verify `chainId`, `signerAddress`, token symbol or token address, and all recipient addresses before signing.
</Warning>