Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
/address-books/request/message
Authorizations
secret-keystringRequired
Body
idintegerOptional
bookintegerRequired
tostringOptional
accessstring · enumRequiredPossible values:
pendingbooleanOptionalDefault: true
acceptedbooleanOptionalDefault: false
createdAtstring · date-timeOptional
updatedAtstring · date-timeRequired
Responses
200

Successful response

application/json
statusintegerOptional
timestampstring · date-timeOptional
post/address-books/request/message
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: 155

{
  "id": 1,
  "book": 1,
  "to": "text",
  "access": "READ",
  "pending": true,
  "accepted": false,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}
{
  "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": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "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": "2026-01-01T00:00:00.000Z",
                "createdAt": "2026-01-01T00:00:00.000Z"
              },
              "chainId": 1,
              "isMultisig": false,
              "isSmartContractWallet": false,
              "walletId": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "rpc": [
                  "text"
                ],
                "type": "EVM",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2026-01-01T00:00:00.000Z",
                "createdAt": "2026-01-01T00:00:00.000Z"
              },
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "createdAt": "2026-01-01T00:00:00.000Z"
            },
            "secondary": "[Circular Reference]",
            "nonce": 0,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": false,
            "syncedAt": "2026-01-01T00:00:00.000Z",
            "createdAt": "2026-01-01T00:00:00.000Z"
          },
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        },
        "requests": [
          {
            "id": 1,
            "bookId": 1,
            "book": "[Circular Reference]",
            "toId": "text",
            "to": "[Circular Reference]",
            "access": "READ",
            "pending": true,
            "accepted": false,
            "createdAt": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "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": "2026-01-01T00:00:00.000Z",
              "createdAt": "2026-01-01T00:00:00.000Z"
            },
            "chainId": 1,
            "isMultisig": false,
            "isSmartContractWallet": false,
            "walletId": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "rpc": [
                "text"
              ],
              "type": "EVM",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "createdAt": "2026-01-01T00:00:00.000Z"
            },
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "createdAt": "2026-01-01T00:00:00.000Z"
          },
          "secondary": "[Circular Reference]",
          "nonce": 0,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": false,
          "syncedAt": "2026-01-01T00:00:00.000Z",
          "createdAt": "2026-01-01T00:00:00.000Z"
        },
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "access": "READ",
      "pending": true,
      "accepted": false,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  },
  "status": 1,
  "timestamp": "2026-01-01T00:00:00.000Z"
}

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

Call API

Create address book request

post
/address-books/request
Authorizations
secret-keystringRequired
Body
idintegerOptional
signaturestringOptional
bookintegerRequired
tostringOptional
accessstring · enumRequiredPossible values:
pendingbooleanOptionalDefault: true
acceptedbooleanOptionalDefault: false
createdAtstring · date-timeOptional
updatedAtstring · date-timeRequired
Responses
200

Successful response

application/json
statusintegerOptional
timestampstring · date-timeOptional
post/address-books/request
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: 174

{
  "id": 1,
  "signature": "text",
  "book": 1,
  "to": "text",
  "access": "READ",
  "pending": true,
  "accepted": false,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}
{
  "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": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "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": "2026-01-01T00:00:00.000Z",
                "createdAt": "2026-01-01T00:00:00.000Z"
              },
              "chainId": 1,
              "isMultisig": false,
              "isSmartContractWallet": false,
              "walletId": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "rpc": [
                  "text"
                ],
                "type": "EVM",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2026-01-01T00:00:00.000Z",
                "createdAt": "2026-01-01T00:00:00.000Z"
              },
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "createdAt": "2026-01-01T00:00:00.000Z"
            },
            "secondary": "[Circular Reference]",
            "nonce": 0,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": false,
            "syncedAt": "2026-01-01T00:00:00.000Z",
            "createdAt": "2026-01-01T00:00:00.000Z"
          },
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        },
        "requests": [
          {
            "id": 1,
            "bookId": 1,
            "book": "[Circular Reference]",
            "toId": "text",
            "to": "[Circular Reference]",
            "access": "READ",
            "pending": true,
            "accepted": false,
            "createdAt": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "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": "2026-01-01T00:00:00.000Z",
              "createdAt": "2026-01-01T00:00:00.000Z"
            },
            "chainId": 1,
            "isMultisig": false,
            "isSmartContractWallet": false,
            "walletId": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "rpc": [
                "text"
              ],
              "type": "EVM",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "createdAt": "2026-01-01T00:00:00.000Z"
            },
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "createdAt": "2026-01-01T00:00:00.000Z"
          },
          "secondary": "[Circular Reference]",
          "nonce": 0,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": false,
          "syncedAt": "2026-01-01T00:00:00.000Z",
          "createdAt": "2026-01-01T00:00:00.000Z"
        },
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "access": "READ",
      "pending": true,
      "accepted": false,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  },
  "status": 1,
  "timestamp": "2026-01-01T00:00:00.000Z"
}

Websockets & Webhooks

Coming soon...

PreviousHow to create address books?NextHow to accept address book request?

Last updated