curl --request GET \
--url https://api.sandbox.brickken.com/get-token-info \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-token-info"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.brickken.com/get-token-info', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.brickken.com/get-token-info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.brickken.com/get-token-info"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.brickken.com/get-token-info")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-token-info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"tokenName": "<string>",
"tokenSymbol": "<string>",
"tokenType": "<string>",
"tokenizerEmail": "<string>",
"companyWalletAddress": "<string>",
"tokenLogotype": "<string>",
"subscriptionAgreement": "<string>",
"legalDocs": "<string>",
"allowedTokenDecimals": 123,
"initialTokenSupply": "<string>",
"maxTokenSupply": "<string>",
"paymentToken": {
"symbol": "<string>",
"address": "<string>",
"decimals": 123,
"blockchain": {
"chainId": "<string>",
"chainName": "<string>",
"blockExplorerUrl": "<string>"
}
}
}Get Token Information
Description: Reads token information. The endpoint has two modes.
- With
tokenSymbol: returns the stored record of that tokenized asset. - Without
tokenSymbol: returns the token symbols and tokenizer emails available to the API key.
This endpoint does not return the deployed token contract address and does not return wallet balances. Use GET /get-tokenizer-info for the contract address (tokenAddress) and GET /get-balance-whitelist for balances.
Headers:
x-api-key:YOUR_API_KEY
Query Parameters:
tokenSymbol(string, optional): The symbol of the token.
curl --request GET \
--url https://api.sandbox.brickken.com/get-token-info \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-token-info"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.brickken.com/get-token-info', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.brickken.com/get-token-info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.brickken.com/get-token-info"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.brickken.com/get-token-info")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-token-info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"tokenName": "<string>",
"tokenSymbol": "<string>",
"tokenType": "<string>",
"tokenizerEmail": "<string>",
"companyWalletAddress": "<string>",
"tokenLogotype": "<string>",
"subscriptionAgreement": "<string>",
"legalDocs": "<string>",
"allowedTokenDecimals": 123,
"initialTokenSupply": "<string>",
"maxTokenSupply": "<string>",
"paymentToken": {
"symbol": "<string>",
"address": "<string>",
"decimals": 123,
"blockchain": {
"chainId": "<string>",
"chainName": "<string>",
"blockExplorerUrl": "<string>"
}
}
}tokenSymbol.
newTokenization succeeds, read
the address from GET /get-tokenizer-info as tokenAddress.
It also does not return wallet balances — use
GET /get-balance-whitelist for those.Query Parameters
tokenSymbol(optional): Token symbol. Omit it to list what the API key can see.
Mode 1 — list what the API key can see
OmittokenSymbol. Useful right after a tokenization, to confirm the new symbol is registered.
curl --request GET \
--url 'https://api.sandbox.brickken.com/get-token-info' \
--header 'x-api-key: YOUR_API_KEY'
{
"tokenSymbols": [
"EXMPL"
],
"tokenizerEmails": [
"tokenizer@example.com"
]
}
Mode 2 — read one asset record
SendtokenSymbol. Your key must be the tokenizer of that token, or the call returns Unauthorized token symbol.
curl --request GET \
--url 'https://api.sandbox.brickken.com/get-token-info?tokenSymbol=EXMPL' \
--header 'x-api-key: YOUR_API_KEY'
{
"uuid": "a5232594-3f97-47d0-b362-491caac9388f",
"name": "Example Corp",
"tokenName": "Example Token",
"tokenSymbol": "EXMPL",
"tokenType": "equity",
"tokenizerEmail": "tokenizer@example.com",
"companyWalletAddress": "0x1111111111111111111111111111111111111111",
"tokenLogotype": "https://cdn.example.com/logo.png",
"subscriptionAgreement": "ipfs://...",
"legalDocs": "ipfs://...",
"allowedTokenDecimals": 18,
"initialTokenSupply": "1000000",
"maxTokenSupply": "10000000",
"paymentToken": {
"symbol": "USDC",
"address": "0x2222222222222222222222222222222222222222",
"decimals": 6,
"blockchain": {
"chainId": "aa36a7",
"chainName": "Ethereum Sepolia",
"blockExplorerUrl": "https://sepolia.etherscan.io"
}
}
}
Where to find each address
| You need | Endpoint | Field |
|---|---|---|
| Token contract address | GET /get-tokenizer-info | tokenAddress |
| Payment token address | GET /get-tokenizer-info | paymentTokenAddress |
| Escrow address | GET /get-tokenizer-info | escrowAddress |
| Factory and BKN addresses | GET /get-network-info | factoryAddress, BKNAddress |
| Holder balance | GET /get-balance-whitelist | tokenBalance |
Authorizations
Query Parameters
The symbol of the token. Omit it to list the symbols available to the API key.
Response
Successful response
- Option 1
- Option 2
The asset record when tokenSymbol is supplied, otherwise the symbols and tokenizer emails available to the API key.
Internal identifier of the tokenized asset.
Company or asset name.
Token name.
Token symbol.
Token type.
Email of the tokenizer that owns the asset.
Wallet address of the tokenizer company.
Token logo reference.
Subscription agreement reference.
Legal documentation reference.
Decimals configured for the token.
Initial token supply.
Maximum token supply.
Show child attributes
Show child attributes