LogoLogo
AppBlogTwitterDiscord
  • Overview
    • .bnb Name Service
    • .arb Name Service
    • SPACE ID Token (ID)
    • Roadmap
  • - DOMAIN & PAYMENT ID -
    • Domain Tutorials
      • Set Up a Wallet
      • Discover
      • Register
      • Trade
      • Manage
    • Domain Programs
      • SPACE ID Premier Club
      • SPACE ID DAO
      • SPACE ID Grant Program
      • SPACE ID Referral Program
      • SPACE ID Gift Card
      • SPACE ID Cosmic Council
      • SPACE ID Voyage Season 2 - Calling
    • Using Domain on MetaMask Snap
      • Knowledge Base
      • General FAQ
  • Payment ID
    • Architecture
    • ZK Email Oauth Login
    • Key Terms
    • Core Contracts
      • PID
      • PIDRegistry
      • RegistrationController
      • AddrResolver
      • PublicResolver
    • Contract Addresses
  • - Launch your TLDs with SPACE ID -
    • Overview
    • Step by Step Guide
    • Demos of One-Stop Domain Issuance Toolkit
  • - Developer Guide -
    • Web3 Name API & SDK
      • Web3 Name API
      • Web3 Name SDK
      • FAQ
    • Registration Integration
    • Integration Partners
  • - Legal -
    • Terms of Use
  • Links
    • Github
    • Brand Kit
    • Website
    • Blog
    • Twitter
    • Discord
    • Telegram
Powered by GitBook
On this page
  • 1. What is the SPACE ID Web3 Name API?
  • 2. How do I access the API?
  • 3. How do I resolve a domain to an address using the API?
  • 4. How do I reverse resolve an address to a domain?
  • 5. What is the SPACE ID Web3 Name SDK, and what's the difference between SDK and API?
  • 6. How do I install the SDK and resolve domain names?
  1. - Developer Guide -
  2. Web3 Name API & SDK

FAQ

1. What is the SPACE ID Web3 Name API?

The Web3 Name API is a free HTTP API that helps developers integrate Web3 domains to their apps, efficiently and securely. The API provides:

  • Domain resolution: convert Web3 Domains into crypto addresses.

  • Reverse resolution: retrieve the primary Web3 Domain uniquely linked to the crypto address.

2. How do I access the API?

You can access the API simply by sending requests to the endpoint URLs (as stated below) using the HTTP method GET.

3. How do I resolve a domain to an address using the API?

Send a GET request:

https://nameapi.space.id/getAddress?domain=spaceid.bnb

Response: { "address": "0xb5932a6B7d50A966AEC6C74C97385412Fb497540"}

4. How do I reverse resolve an address to a domain?

Send a GET request:

https://nameapi.space.id/getName?chainid=56&address=0xb5932a6B7d50A966AEC6C74C97385412Fb497540

Response: {"name": "spaceid.bnb"}

5. What is the SPACE ID Web3 Name SDK, and what's the difference between SDK and API?

The SDK is a JavaScript/TypeScript library designed for client-side and backend integrations, allowing developers to directly query on-chain domain records inside their apps instead of handling API calls.

Conversely, the API is a RESTful service that enables developers to access SPACE ID’s domain name resolution via HTTP requests, making it ideal for server-side applications and large-scale integrations.

6. How do I install the SDK and resolve domain names?

Developers can install the Web3 Name SDK via:

npm install @web3-name-sdk/core viem@^1.20

And check the complete SDK documents here:

PreviousWeb3 Name SDKNextRegistration Integration

Last updated 2 months ago

https://docs.space.id/developer-guide/web3-name-api-and-sdk/web3-name-sdk