Fetcch
  • 🟠What is Fetcch?
  • 🚅Pull Payments Layer
    • 🔭Overview
    • ❓How it works?
      • 👮Specification
      • 🎒How is it stored?
      • 🌊Pull Payments Flow
    • 🔐Security
      • 🎒Storage
      • ⛓️Cross Chain
    • ⚔️Use Pull Payments
  • 🆔Universal Identity Layer
    • 🔭Overview
    • ❓How it works?
      • 👮Specifications
      • 🎒How is it stored?
      • 🌊Identity Flow
    • 🔐Security
      • 🎒Storage
    • ⚔️Use Fetcch Identity
  • 🏗️Data Structures
    • 📖Address Books
      • 🔭Overview
      • 🎒Storage
  • 💻How to integrate?
    • ✈️Quickstart
    • ⛷️SDK Quickstart
    • 🔓Blockchain
    • ✨Guides
      • 🙇Authentication
      • 😁Identity
        • How to resolve identity?
        • How to create identity?
        • How to update identity?
      • 🤌Transaction Requests
        • How to get transaction requests?
        • How to create transaction request?
        • How to build transaction?
        • How to resolve transaction request?
      • 🫂Address Books
        • How to get address books?
        • How to create address books?
        • How to share address book?
        • How to accept address book request?
      • ⚙️Utility
        • How to sign messages?
          • EVM
          • Solana
          • Aptos
          • EIP-6492 Compatible Signatures
        • How to generate & verify proofs for identity?
    • 📖API Reference
      • ☢️Troubleshooting Errors
      • 🟢OpenAPI Specs
  • 🐧Open Source
    • 📸@fetcch/resolve-names
  • 🥶FAQs
    • FAQs
Powered by GitBook
On this page
  1. How to integrate?
  2. Guides
  3. Address Books

How to get address books?

Process of fetching address books

PreviousAddress BooksNextHow to create address books?

Last updated 1 year ago

Address books can fetched based on 2 parameters

  • id - can be satyam@metamask, satyam.eth etc

  • name (optional) - can be name of the particular address books

Call API

💻
✨
🫂

Get Address Books

get
Authorizations
Query parameters
idstringOptionalExample: cosmix@fetcch
namestringOptionalExample: cosmix@fetcch
Responses
200Success
application/json
400Error
application/json
401Error
application/json
get
GET /v1/address-books HTTP/1.1
Host: sandbox-api.fetcch.xyz
secret-key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "id": 1,
      "name": "text",
      "addresses": [
        {
          "id": 1,
          "address": "text",
          "chainType": "EVM",
          "name": "text",
          "addressBookId": 1,
          "addressBook": {
            "id": 1,
            "name": "text",
            "addresses": "[Circular Reference]",
            "walletIds": "[Circular Reference]",
            "ownerId": "text",
            "owner": "[Circular Reference]",
            "requests": "[Circular Reference]",
            "createdAt": "2025-05-09T04:33:32.645Z",
            "updatedAt": "2025-05-09T04:33:32.645Z"
          }
        }
      ],
      "walletIds": [
        {
          "id": 1,
          "walletId": "text",
          "wallet": {
            "id": "text",
            "identifier": "text",
            "providerId": "text",
            "provider": "[Circular Reference]",
            "defaultAddress": "text",
            "default": {
              "address": "text",
              "chain": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "rpc": [
                  "text"
                ],
                "type": "EVM",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2025-05-09T04:33:32.645Z",
                "createdAt": "2025-05-09T04:33:32.645Z"
              },
              "chainId": 1,
              "isMultisig": true,
              "isSmartContractWallet": true,
              "walletId": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "rpc": [
                  "text"
                ],
                "type": "EVM",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2025-05-09T04:33:32.645Z",
                "createdAt": "2025-05-09T04:33:32.645Z"
              },
              "updatedAt": "2025-05-09T04:33:32.645Z",
              "createdAt": "2025-05-09T04:33:32.645Z"
            },
            "secondary": "[Circular Reference]",
            "nonce": 1,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": true,
            "syncedAt": "2025-05-09T04:33:32.645Z",
            "createdAt": "2025-05-09T04:33:32.645Z"
          },
          "name": "text",
          "addressBookId": 1,
          "addressBook": {
            "id": 1,
            "name": "text",
            "addresses": "[Circular Reference]",
            "walletIds": "[Circular Reference]",
            "ownerId": "text",
            "owner": "[Circular Reference]",
            "requests": "[Circular Reference]",
            "createdAt": "2025-05-09T04:33:32.645Z",
            "updatedAt": "2025-05-09T04:33:32.645Z"
          },
          "createdAt": "2025-05-09T04:33:32.645Z",
          "updatedAt": "2025-05-09T04:33:32.645Z"
        }
      ],
      "ownerId": "text",
      "owner": {
        "owner": "text",
        "ownerId": "text",
        "ownerIdentity": {
          "id": "text",
          "identifier": "text",
          "providerId": "text",
          "provider": {
            "id": "text",
            "logo": "text",
            "apiKey": "text",
            "delimiter": "text",
            "txHash": "text",
            "registry": "[Circular Reference]",
            "dataSourceId": 1,
            "ownerId": "text",
            "updatedAt": "2025-05-09T04:33:32.645Z",
            "createdAt": "2025-05-09T04:33:32.645Z"
          },
          "defaultAddress": "text",
          "default": {
            "address": "text",
            "chain": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "rpc": [
                "text"
              ],
              "type": "EVM",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2025-05-09T04:33:32.645Z",
              "createdAt": "2025-05-09T04:33:32.645Z"
            },
            "chainId": 1,
            "isMultisig": true,
            "isSmartContractWallet": true,
            "walletId": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "rpc": [
                "text"
              ],
              "type": "EVM",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2025-05-09T04:33:32.645Z",
              "createdAt": "2025-05-09T04:33:32.645Z"
            },
            "updatedAt": "2025-05-09T04:33:32.645Z",
            "createdAt": "2025-05-09T04:33:32.645Z"
          },
          "secondary": [
            "[Circular Reference]"
          ],
          "nonce": 1,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": true,
          "syncedAt": "2025-05-09T04:33:32.645Z",
          "createdAt": "2025-05-09T04:33:32.645Z"
        },
        "createdAt": "2025-05-09T04:33:32.645Z",
        "updatedAt": "2025-05-09T04:33:32.645Z"
      },
      "requests": [
        {
          "id": 1,
          "bookId": 1,
          "book": {
            "id": 1,
            "name": "text",
            "addresses": "[Circular Reference]",
            "walletIds": "[Circular Reference]",
            "ownerId": "text",
            "owner": {
              "owner": "text",
              "ownerId": "text",
              "ownerIdentity": {
                "id": "text",
                "identifier": "text",
                "providerId": "text",
                "provider": {
                  "id": "text",
                  "logo": "text",
                  "apiKey": "text",
                  "delimiter": "text",
                  "txHash": "text",
                  "registry": "[Circular Reference]",
                  "dataSourceId": 1,
                  "ownerId": "text",
                  "updatedAt": "2025-05-09T04:33:32.645Z",
                  "createdAt": "2025-05-09T04:33:32.645Z"
                },
                "defaultAddress": "text",
                "default": {
                  "address": "text",
                  "chain": {
                    "id": 1,
                    "name": "text",
                    "symbol": "text",
                    "icon": "text",
                    "rpc": [
                      "text"
                    ],
                    "type": "EVM",
                    "shortName": "text",
                    "infoURL": "text",
                    "chainId": 1,
                    "updatedAt": "2025-05-09T04:33:32.645Z",
                    "createdAt": "2025-05-09T04:33:32.645Z"
                  },
                  "chainId": 1,
                  "isMultisig": true,
                  "isSmartContractWallet": true,
                  "walletId": {
                    "id": 1,
                    "name": "text",
                    "symbol": "text",
                    "icon": "text",
                    "rpc": [
                      "text"
                    ],
                    "type": "EVM",
                    "shortName": "text",
                    "infoURL": "text",
                    "chainId": 1,
                    "updatedAt": "2025-05-09T04:33:32.645Z",
                    "createdAt": "2025-05-09T04:33:32.645Z"
                  },
                  "updatedAt": "2025-05-09T04:33:32.645Z",
                  "createdAt": "2025-05-09T04:33:32.645Z"
                },
                "secondary": [
                  "[Circular Reference]"
                ],
                "nonce": 1,
                "currentSignature": "text",
                "previousSignature": "text",
                "isContract": true,
                "syncedAt": "2025-05-09T04:33:32.645Z",
                "createdAt": "2025-05-09T04:33:32.645Z"
              },
              "createdAt": "2025-05-09T04:33:32.645Z",
              "updatedAt": "2025-05-09T04:33:32.645Z"
            },
            "requests": "[Circular Reference]",
            "createdAt": "2025-05-09T04:33:32.645Z",
            "updatedAt": "2025-05-09T04:33:32.645Z"
          },
          "toId": "text",
          "to": {
            "owner": "text",
            "ownerId": "text",
            "ownerIdentity": {
              "id": "text",
              "identifier": "text",
              "providerId": "text",
              "provider": {
                "id": "text",
                "logo": "text",
                "apiKey": "text",
                "delimiter": "text",
                "txHash": "text",
                "registry": "[Circular Reference]",
                "dataSourceId": 1,
                "ownerId": "text",
                "updatedAt": "2025-05-09T04:33:32.645Z",
                "createdAt": "2025-05-09T04:33:32.645Z"
              },
              "defaultAddress": "text",
              "default": {
                "address": "text",
                "chain": {
                  "id": 1,
                  "name": "text",
                  "symbol": "text",
                  "icon": "text",
                  "rpc": [
                    "text"
                  ],
                  "type": "EVM",
                  "shortName": "text",
                  "infoURL": "text",
                  "chainId": 1,
                  "updatedAt": "2025-05-09T04:33:32.645Z",
                  "createdAt": "2025-05-09T04:33:32.645Z"
                },
                "chainId": 1,
                "isMultisig": true,
                "isSmartContractWallet": true,
                "walletId": {
                  "id": 1,
                  "name": "text",
                  "symbol": "text",
                  "icon": "text",
                  "rpc": [
                    "text"
                  ],
                  "type": "EVM",
                  "shortName": "text",
                  "infoURL": "text",
                  "chainId": 1,
                  "updatedAt": "2025-05-09T04:33:32.645Z",
                  "createdAt": "2025-05-09T04:33:32.645Z"
                },
                "updatedAt": "2025-05-09T04:33:32.645Z",
                "createdAt": "2025-05-09T04:33:32.645Z"
              },
              "secondary": [
                "[Circular Reference]"
              ],
              "nonce": 1,
              "currentSignature": "text",
              "previousSignature": "text",
              "isContract": true,
              "syncedAt": "2025-05-09T04:33:32.645Z",
              "createdAt": "2025-05-09T04:33:32.645Z"
            },
            "createdAt": "2025-05-09T04:33:32.645Z",
            "updatedAt": "2025-05-09T04:33:32.645Z"
          },
          "access": "READ",
          "pending": true,
          "accepted": true,
          "createdAt": "2025-05-09T04:33:32.645Z",
          "updatedAt": "2025-05-09T04:33:32.645Z"
        }
      ],
      "createdAt": "2025-05-09T04:33:32.645Z",
      "updatedAt": "2025-05-09T04:33:32.645Z"
    }
  ],
  "status": 1,
  "timestamp": "2025-05-09T04:33:32.645Z"
}
  • Call API
  • GETGet Address Books