Communities

Check availability

Check the availability of a community cluster name

GET /v1/names/community/:communityName/check/:name

Example

curl https://api.clusters.xyz/v1/names/community/pengu/check/myname

Response

200

{
  "name": "pengu/myname",
  "isAvailable": false
}

---

Register a community name

Check the availability of one or more clusters

POST /v1/names/community/:communityName/register

Name	Description
HEADER Authorization: Bearer {AUTHKEY}	Authentication key
name	The name you want to register
walletAddress (optional)	If you are the admin of the community, you can register on behalf of someone. If this is left out the name will be registered to the authenticated wallet

Example

curl --request POST \
  --url https://api.clusters.xyz/v1/names/community/pengu/register \
  --header 'Authorization: Bearer AUTHKEY'
  --header 'Content-Type: application/json' \
  --data '{ "name": "myname" }'

Response

200

{
  "clusterName": "pengu/myname",
  "owner": "0x123"
}