Registration
Check availability
Check the availability of one or more clusters
POST
/v1/names/register/check
Name
Description
BODY
string[]
- an array of names to check
Example
curl --request POST \
--url https://api.clusters.xyz/v1/names/register/check \
--header 'Content-Type: application/json' \
--data '["foobar", "namethatdoesntexist"]'
Response
[
{
"name": "foobar",
"isAvailable": false
},
{
"name": "namethatdoesntexist",
"isAvailable": true
}
]
Registration data
POST
/v1/names/register/evm
POST
/v1/names/register/solana
Get the transaction data for registering a cluster so that a user can sign it
Name
Description
network
"1"
"10"
"56"
"137"
"8453"
"81457"
"17000"
"42161"
"43114"
"11155111"
"solana"
sender
The sender's address
names
{ name: string; amountWei?: string }[]
bidAmountWei (optional) is always in ETH and defaults to 0.01 ETH
referralClusterId
(optional)
The cluster id that is referring this registration
Example
curl --request POST \
--url https://api.clusters.xyz/v1/names/register/evm \
--header 'Content-Type: application/json' \
--data '{
"network": "1",
"sender": "0x0000000000000000000000000000000000000001",
"names": [
{ "name": "namethatdoesntexist1" },
{ "name": "namethatdoesntexist2" }
]
}'
Response
{
"type": "evm",
"gasToken": {
"symbol": "ETH",
"decimals": 18
},
"transactionData": {
"to": "0x00000000000e1a99dddd5610111884278bdbda1d",
"data": "0x40bee835000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000002386f26fc10000000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000000000000000000026e616d6574686174646f65736e746578697374310000000000000000000000006e616d6574686174646f65736e74657869737432000000000000000000000000",
"value": "20000000000000000"
},
"registrationFee": "20000000000000000",
"bridgeFee": "0",
"names": [
{
"name": "namethatdoesntexist1",
"amountWei": "10000000000000000",
"amount": "10000000000000000"
},
{
"name": "namethatdoesntexist2",
"amountWei": "10000000000000000",
"amount": "10000000000000000"
}
]
}
Trasaction Status
Checks the status of a transaction
GET
/v1/names/register/tx/:tx
Example
curl https://api.clusters.xyz/v1/names/register/tx/0xffea3b29c64016772b7d3194b3c3899a62191e654990b6e3393b410667102284
Response
type status = 'not_found' | 'bridging' | 'invalid' | 'finalized'
{
"tx": "0xffea3b29c64016772b7d3194b3c3899a62191e654990b6e3393b410667102284",
"status": "finalized"
}
Last updated