Get Whitelist Status
curl --request GET \
--url https://api.sandbox.brickken.com/get-whitelist-status \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-whitelist-status"
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-whitelist-status', 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-whitelist-status",
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-whitelist-status"
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-whitelist-status")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-whitelist-status")
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{
"isWhitelisted": true,
"address": "<string>",
"tokenSymbol": "<string>",
"source": "blockchain"
}Read Endpoints
Get Whitelist Status
Description: Reads the whitelist flag of an address directly from the token contract.
Headers:
x-api-key:YOUR_API_KEY
Query Parameters:
tokenSymbol(string): The symbol of the token.address(string): Wallet address to check.investorAddressis accepted as a legacy alias.
GET
/
get-whitelist-status
Get Whitelist Status
curl --request GET \
--url https://api.sandbox.brickken.com/get-whitelist-status \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-whitelist-status"
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-whitelist-status', 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-whitelist-status",
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-whitelist-status"
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-whitelist-status")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-whitelist-status")
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{
"isWhitelisted": true,
"address": "<string>",
"tokenSymbol": "<string>",
"source": "blockchain"
}Checks the token contract directly to determine whether an address is whitelisted.
Query Parameters
tokenSymbol(required): Token symboladdress(required): Wallet address to check.investorAddressis accepted as a legacy alias — send either one.
Example
curl --request GET \
--url 'https://api.sandbox.brickken.com/get-whitelist-status?tokenSymbol=EXMPL&address=0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b' \
--header 'x-api-key: YOUR_API_KEY'
Response
{
"isWhitelisted": true,
"address": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
"tokenSymbol": "EXMPL",
"source": "blockchain"
}
address is returned in checksummed form, and source is always blockchain because the flag is read from the
token contract rather than from Brickken’s database.Authorizations
Query Parameters
The symbol of the token.
Wallet address to check. investorAddress is accepted as a legacy alias.
Legacy alias of address. Send either one, not both.
Response
200 - application/json
Successful response