How to share address book?

Sharing address books has never been easy

Arrange Data

Arrange data in the format

{
    "toId": "string"
    "book": number
    "access": "READ" | "READWRITE"
}

Generate & Sign Message

Call this API to get the message

Generate message for sharing address book

post

Authorizations

Body

idintegerOptional

bookintegerRequired

tostringOptional

accessstring · enumRequiredPossible values:

pendingbooleanOptionalDefault: true

acceptedbooleanOptionalDefault: false

createdAtstring · date-timeOptional

updatedAtstring · date-timeRequired

Responses

200

Successful response

application/json

400Error

application/json

401Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/address-books/request/message HTTP/1.1
Host: sandbox-api.fetcch.xyz
secret-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "id": 1,
  "book": 1,
  "to": "text",
  "access": "READ",
  "pending": true,
  "accepted": true,
  "createdAt": "2025-05-12T04:45:41.519Z",
  "updatedAt": "2025-05-12T04:45:41.519Z"
}

{
  "data": {
    "message": "text",
    "request": {
      "id": 1,
      "bookId": 1,
      "book": {
        "id": 1,
        "name": "text",
        "addresses": [
          {
            "id": 1,
            "address": "text",
            "chainType": "EVM",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]"
          }
        ],
        "walletIds": [
          {
            "id": 1,
            "walletId": "text",
            "wallet": "[Circular Reference]",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]",
            "createdAt": "2025-05-12T04:45:41.519Z",
            "updatedAt": "2025-05-12T04:45:41.519Z"
          }
        ],
        "ownerId": "text",
        "owner": {
          "owner": "text",
          "ownerId": "text",
          "ownerIdentity": {
            "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-12T04:45:41.519Z",
                "createdAt": "2025-05-12T04:45:41.519Z"
              },
              "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-12T04:45:41.519Z",
                "createdAt": "2025-05-12T04:45:41.519Z"
              },
              "updatedAt": "2025-05-12T04:45:41.519Z",
              "createdAt": "2025-05-12T04:45:41.519Z"
            },
            "secondary": "[Circular Reference]",
            "nonce": 1,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": true,
            "syncedAt": "2025-05-12T04:45:41.519Z",
            "createdAt": "2025-05-12T04:45:41.519Z"
          },
          "createdAt": "2025-05-12T04:45:41.519Z",
          "updatedAt": "2025-05-12T04:45:41.519Z"
        },
        "requests": [
          {
            "id": 1,
            "bookId": 1,
            "book": "[Circular Reference]",
            "toId": "text",
            "to": "[Circular Reference]",
            "access": "READ",
            "pending": true,
            "accepted": true,
            "createdAt": "2025-05-12T04:45:41.519Z",
            "updatedAt": "2025-05-12T04:45:41.519Z"
          }
        ],
        "createdAt": "2025-05-12T04:45:41.519Z",
        "updatedAt": "2025-05-12T04:45:41.519Z"
      },
      "toId": "text",
      "to": {
        "owner": "text",
        "ownerId": "text",
        "ownerIdentity": {
          "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-12T04:45:41.519Z",
              "createdAt": "2025-05-12T04:45:41.519Z"
            },
            "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-12T04:45:41.519Z",
              "createdAt": "2025-05-12T04:45:41.519Z"
            },
            "updatedAt": "2025-05-12T04:45:41.519Z",
            "createdAt": "2025-05-12T04:45:41.519Z"
          },
          "secondary": "[Circular Reference]",
          "nonce": 1,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": true,
          "syncedAt": "2025-05-12T04:45:41.519Z",
          "createdAt": "2025-05-12T04:45:41.519Z"
        },
        "createdAt": "2025-05-12T04:45:41.519Z",
        "updatedAt": "2025-05-12T04:45:41.519Z"
      },
      "access": "READ",
      "pending": true,
      "accepted": true,
      "createdAt": "2025-05-12T04:45:41.519Z",
      "updatedAt": "2025-05-12T04:45:41.519Z"
    }
  },
  "status": 1,
  "timestamp": "2025-05-12T04:45:41.519Z"
}

Sign the above message by following signature guidelines mentioned here according to the chain you are using

Call API

Create address book request

post

Authorizations

Body

idintegerOptional

signaturestringOptional

bookintegerRequired

tostringOptional

accessstring · enumRequiredPossible values:

pendingbooleanOptionalDefault: true

acceptedbooleanOptionalDefault: false

createdAtstring · date-timeOptional

updatedAtstring · date-timeRequired

Responses

200

Successful response

application/json

400Error

application/json

401Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/address-books/request HTTP/1.1
Host: sandbox-api.fetcch.xyz
secret-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "id": 1,
  "signature": "text",
  "book": 1,
  "to": "text",
  "access": "READ",
  "pending": true,
  "accepted": true,
  "createdAt": "2025-05-12T04:45:41.519Z",
  "updatedAt": "2025-05-12T04:45:41.519Z"
}

{
  "data": {
    "message": "text",
    "request": {
      "id": 1,
      "bookId": 1,
      "book": {
        "id": 1,
        "name": "text",
        "addresses": [
          {
            "id": 1,
            "address": "text",
            "chainType": "EVM",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]"
          }
        ],
        "walletIds": [
          {
            "id": 1,
            "walletId": "text",
            "wallet": "[Circular Reference]",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]",
            "createdAt": "2025-05-12T04:45:41.519Z",
            "updatedAt": "2025-05-12T04:45:41.519Z"
          }
        ],
        "ownerId": "text",
        "owner": {
          "owner": "text",
          "ownerId": "text",
          "ownerIdentity": {
            "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-12T04:45:41.519Z",
                "createdAt": "2025-05-12T04:45:41.519Z"
              },
              "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-12T04:45:41.519Z",
                "createdAt": "2025-05-12T04:45:41.519Z"
              },
              "updatedAt": "2025-05-12T04:45:41.519Z",
              "createdAt": "2025-05-12T04:45:41.519Z"
            },
            "secondary": "[Circular Reference]",
            "nonce": 1,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": true,
            "syncedAt": "2025-05-12T04:45:41.519Z",
            "createdAt": "2025-05-12T04:45:41.519Z"
          },
          "createdAt": "2025-05-12T04:45:41.519Z",
          "updatedAt": "2025-05-12T04:45:41.519Z"
        },
        "requests": [
          {
            "id": 1,
            "bookId": 1,
            "book": "[Circular Reference]",
            "toId": "text",
            "to": "[Circular Reference]",
            "access": "READ",
            "pending": true,
            "accepted": true,
            "createdAt": "2025-05-12T04:45:41.519Z",
            "updatedAt": "2025-05-12T04:45:41.519Z"
          }
        ],
        "createdAt": "2025-05-12T04:45:41.519Z",
        "updatedAt": "2025-05-12T04:45:41.519Z"
      },
      "toId": "text",
      "to": {
        "owner": "text",
        "ownerId": "text",
        "ownerIdentity": {
          "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-12T04:45:41.519Z",
              "createdAt": "2025-05-12T04:45:41.519Z"
            },
            "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-12T04:45:41.519Z",
              "createdAt": "2025-05-12T04:45:41.519Z"
            },
            "updatedAt": "2025-05-12T04:45:41.519Z",
            "createdAt": "2025-05-12T04:45:41.519Z"
          },
          "secondary": "[Circular Reference]",
          "nonce": 1,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": true,
          "syncedAt": "2025-05-12T04:45:41.519Z",
          "createdAt": "2025-05-12T04:45:41.519Z"
        },
        "createdAt": "2025-05-12T04:45:41.519Z",
        "updatedAt": "2025-05-12T04:45:41.519Z"
      },
      "access": "READ",
      "pending": true,
      "accepted": true,
      "createdAt": "2025-05-12T04:45:41.519Z",
      "updatedAt": "2025-05-12T04:45:41.519Z"
    }
  },
  "status": 1,
  "timestamp": "2025-05-12T04:45:41.519Z"
}

Websockets & Webhooks

Coming soon...