Clusters
  • Introduction
    • Overview
    • Concepts
      • Cluster Name
      • Wallet Name
    • Features
      • Communities
      • Multichain
      • Wallet Bundles
      • Antisquatting
      • Wallet Generation
      • Selective Wallet Sharing
  • Getting started
    • Javascript
      • Authentication
      • Clusters
      • Address → Cluster Name
      • Cluster Name → Address
      • Registration
        • Communities
      • Event Indexing
    • API
      • v1
        • Authentication
        • Clusters
        • Address → Cluster Name
        • Cluster Name → Address
        • Registration
          • Communities
        • Event Indexing
      • v0.1 (Deprecated)
        • Address → Cluster
        • Cluster → Address
        • Cluster → Metadata
        • Registration
        • Managing Wallets
  • Resources
    • Smart Contracts
    • Address Types
    • Using Clusters for ETH->SOL Airdrops
  • Integration Guides
    • Convert hex address to clusters name
    • Registering a name
      • Ethereum Networks
      • Solana
    • Whitelabel Communities Registration Flow
Powered by GitBook
On this page
  • Check availability
  • Register a community name
  1. Getting started
  2. API
  3. v1
  4. Registration

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

{
  "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

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

Last updated 1 month ago