create entity
curl --request POST \
--url https://api.example.com/api/v1/contract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"projectId": 123,
"name": "USDT contract",
"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"category": "<string>",
"abi": [
{}
],
"addressType": "CONTRACT",
"amlRequired": false,
"icon": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/v1/contract"
payload = {
"projectId": 123,
"name": "USDT contract",
"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"category": "<string>",
"abi": [{}],
"addressType": "CONTRACT",
"amlRequired": False,
"icon": "<string>",
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
projectId: 123,
name: 'USDT contract',
address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
category: '<string>',
abi: [{}],
addressType: 'CONTRACT',
amlRequired: false,
icon: '<string>',
tags: ['<string>']
})
};
fetch('https://api.example.com/api/v1/contract', 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.example.com/api/v1/contract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'projectId' => 123,
'name' => 'USDT contract',
'address' => '0xdac17f958d2ee523a2206206994597c13d831ec7',
'category' => '<string>',
'abi' => [
[
]
],
'addressType' => 'CONTRACT',
'amlRequired' => false,
'icon' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/contract"
payload := strings.NewReader("{\n \"projectId\": 123,\n \"name\": \"USDT contract\",\n \"address\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"category\": \"<string>\",\n \"abi\": [\n {}\n ],\n \"addressType\": \"CONTRACT\",\n \"amlRequired\": false,\n \"icon\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/contract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"projectId\": 123,\n \"name\": \"USDT contract\",\n \"address\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"category\": \"<string>\",\n \"abi\": [\n {}\n ],\n \"addressType\": \"CONTRACT\",\n \"amlRequired\": false,\n \"icon\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/contract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"projectId\": 123,\n \"name\": \"USDT contract\",\n \"address\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"category\": \"<string>\",\n \"abi\": [\n {}\n ],\n \"addressType\": \"CONTRACT\",\n \"amlRequired\": false,\n \"icon\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"createdAt": 123,
"updatedAt": 123,
"projectId": 123,
"chainUid": "arbitrum",
"address": "<string>",
"implementation": "<string>",
"name": "<string>",
"category": "<string>",
"tags": [
"<string>"
],
"addressType": "CONTRACT",
"amlRequired": true,
"icon": "<string>"
}Contract Route
create entity
POST
/
api
/
v1
/
contract
create entity
curl --request POST \
--url https://api.example.com/api/v1/contract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"projectId": 123,
"name": "USDT contract",
"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"category": "<string>",
"abi": [
{}
],
"addressType": "CONTRACT",
"amlRequired": false,
"icon": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/v1/contract"
payload = {
"projectId": 123,
"name": "USDT contract",
"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"category": "<string>",
"abi": [{}],
"addressType": "CONTRACT",
"amlRequired": False,
"icon": "<string>",
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
projectId: 123,
name: 'USDT contract',
address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
category: '<string>',
abi: [{}],
addressType: 'CONTRACT',
amlRequired: false,
icon: '<string>',
tags: ['<string>']
})
};
fetch('https://api.example.com/api/v1/contract', 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.example.com/api/v1/contract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'projectId' => 123,
'name' => 'USDT contract',
'address' => '0xdac17f958d2ee523a2206206994597c13d831ec7',
'category' => '<string>',
'abi' => [
[
]
],
'addressType' => 'CONTRACT',
'amlRequired' => false,
'icon' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/contract"
payload := strings.NewReader("{\n \"projectId\": 123,\n \"name\": \"USDT contract\",\n \"address\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"category\": \"<string>\",\n \"abi\": [\n {}\n ],\n \"addressType\": \"CONTRACT\",\n \"amlRequired\": false,\n \"icon\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/contract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"projectId\": 123,\n \"name\": \"USDT contract\",\n \"address\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"category\": \"<string>\",\n \"abi\": [\n {}\n ],\n \"addressType\": \"CONTRACT\",\n \"amlRequired\": false,\n \"icon\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/contract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"projectId\": 123,\n \"name\": \"USDT contract\",\n \"address\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"category\": \"<string>\",\n \"abi\": [\n {}\n ],\n \"addressType\": \"CONTRACT\",\n \"amlRequired\": false,\n \"icon\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"createdAt": 123,
"updatedAt": 123,
"projectId": 123,
"chainUid": "arbitrum",
"address": "<string>",
"implementation": "<string>",
"name": "<string>",
"category": "<string>",
"tags": [
"<string>"
],
"addressType": "CONTRACT",
"amlRequired": true,
"icon": "<string>"
}Authorizations
Authentication
Body
application/json
The project ID associated with the extractor contract
Name for the entity
Pattern:
\SExample:
"USDT contract"
Network uid that associated with extractor contract
Available options:
arbitrum, bsc, bsc_testnet, ethereum, linea, optimism, base, base_sepolia, gnosis, fantom, polygon, polygon_amoy, blast, zksync, scroll, avalanche, avalanche_fuji, telos, sepolia, holesky, ethereum_sepolia, ethereum_holesky, tron, zeta, somnia, adi, anvil, icp, vechain, stellar, bitcoin, solana The direct address of the extractor contract
Example:
"0xdac17f958d2ee523a2206206994597c13d831ec7"
Contract category
Contract abi, example: [{"input": "source"}] (We are using it as a main contract abi, even if the address is a proxy contract address)
Show child attributes
Show child attributes
The type of a provided address, could be "Contract" or "Wallet"
Available options:
CONTRACT, WALLET, ENTITY Example:
"CONTRACT"
If the AML detector required for this contract. Default: false
A URL of an icon for the contract
Contract tags
Response
200 - application/json
OK
Unique identifier of the entity
Example:
1
Time when entity was created
Time when entity was updated
The project ID associated with the extractor contract
Network uid that associated with extractor contract
Available options:
arbitrum, bsc, bsc_testnet, ethereum, linea, optimism, base, base_sepolia, gnosis, fantom, polygon, polygon_amoy, blast, zksync, scroll, avalanche, avalanche_fuji, telos, sepolia, holesky, ethereum_sepolia, ethereum_holesky, tron, zeta, somnia, adi, anvil, icp, vechain, stellar, bitcoin, solana The direct address of the extractor contract
Implementation address associated with the extractor contract, not null means this is a proxy contract
Name for the entity
Contract category
Contract tags
The type of a provided address, could be "Contract" or "Wallet"
Available options:
CONTRACT, WALLET, ENTITY If the AML detector required for this contract. Default: false
A URL of an icon for the contract