Get a specific STO by its UUID
curl --request GET \
--url https://api.sandbox.brickken.com/get-sto-by-id \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-sto-by-id"
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-sto-by-id', 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-sto-by-id",
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-sto-by-id"
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-sto-by-id")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-sto-by-id")
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>",
"status": "<string>",
"tokenAmount": "<string>",
"hardCap": "<string>",
"softCap": "<string>",
"maxInvestment": "<string>",
"minInvestment": "<string>",
"tokenSymbol": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"tokenPrice": "<string>",
"acceptedCoin": "<string>",
"escrow": "<string>"
}Read Endpoints
Get STO by ID
Read one Security Token Offering by its identifier.
GET
/
get-sto-by-id
Get a specific STO by its UUID
curl --request GET \
--url https://api.sandbox.brickken.com/get-sto-by-id \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-sto-by-id"
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-sto-by-id', 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-sto-by-id",
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-sto-by-id"
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-sto-by-id")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-sto-by-id")
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>",
"status": "<string>",
"tokenAmount": "<string>",
"hardCap": "<string>",
"softCap": "<string>",
"maxInvestment": "<string>",
"minInvestment": "<string>",
"tokenSymbol": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"tokenPrice": "<string>",
"acceptedCoin": "<string>",
"escrow": "<string>"
}Requires
x-api-key. Returns the full record for a single offering — supply, price, dates, status, the escrow
contract address, and the associated token.
Your key must be the tokenizer of the token behind the offering, or the call returns Unauthorized token symbol. See Authentication.
Use GET /get-stos to list every offering for a token and discover the IDs.Authorizations
Query Parameters
The symbol of the token.
The unique identifier (UUID) of the STO.
Response
200 - application/json
Successful response
Offering identifier. Pass it as id to the other STO endpoints.
Offering name.
Offering status.
Tokens allocated to the offering.
Maximum raise in USD.
Minimum raise in USD.
Maximum investment per investor.
Minimum investment per investor.
Token symbol of the asset.
Offering start date.
Offering end date.
Token price for the offering.
Payment token accepted by the offering.
Escrow contract address of the offering.