API
API
NameStone's API lets you grant names (subdomains), set text records, and retrieve information about domains.
To use our API, you'll need an API key for authentication.
Get Started
Use this form to enable your domain and receive a free API key via email, or enable your name programmatically via the enable-domain endpoint. Your domain's resolver must be set to:
0xA87361C4E58B619c390f469B9E6F27d759715125
If you are managing a DNS domain, head to Gasless DNS for setup instructions.
Authentication
To authenticate with the NameStone API, you need to provide your API key in the header of your request or as a query parameter
api_key.Endpoints
Learn more about our API endpoints, separated by name and domain routes:
| Name Routes | Description |
|---|---|
| set-name | Set a name and text records for a given address and domain. |
| claim-name | Claim a name and text records for a given address and domain. If name exists route will throw an error. |
| get-names | Fetch names and text records for a given address and domain. |
| delete-name | Remove a given name for an address and a name. |
| Domain Routes | Description |
|---|---|
| set-domain | Set a domain and text records for a given address. |
| get-domain | Get text records and address for a given domain. |
| enable-domain | Enable your domain on namestone. Requires a signed message from get-siwe-message. |
| get-siwe-message | Get a signable siwe message for accessing protected routes like enable-domain. |