API

Web3Modal has it's own api available at api.web3modal.com that is used to fetch wallet data from a WalletConnect maintained wallet & dapp registry.

All responses are cached for a minimum of 2h.

Headers

All api requests must contain following headers. See types

interface Headers {
  "x-project-id": string;
  "x-sdk-type": SdkType;
  "x-sdk-version": SdkVersion;
}

Methods

GET /getWallets

Returns total count and wallet data, based on provided body inputs. See types.

interface Request {
  headers: Headers;
}

interface UrlQueryParams {
  page: string; // eg. 1
  entries: string; // eg. 100
  search?: string; // eg. MetaMa...
  include?: string; // eg. id1,id2,id3
  exclude?: string; // eg. id1,id2,id3
  platform?: "ios" | "android";
}

interface Response {
  count: number;
  data: Array<{
    id: string;
    name: string;
    homepage: string;
    image_id: string;
    order: number;
    mobile_link: string | null;
    desktop_link: string | null;
    webapp_link: string | null;
    app_store: string | null;
    play_store: string | null;
    injected:
      | {
          namespace: string;
          injected_id: string;
        }[]
      | null;
  }>;
}

GET /getWalletImage/:wallet_id

Returns image logo for requested wallet_id. See types.

interface Request {
  headers: Headers;
}

type Response = Blob;

GET /public/getAssetImage/:asset_id

Returns image for public asset for requested asset_id, i.e network logo, token logo or connector logo.

interface Request {
  headers: Headers;
}

type Response = Blob;

Known Static Asset IDs

There are a number of known static asset IDs that can be used to fetch images, e.g. for networks and connectors:

// Maps EIP155 chain IDs -> `asset_id`
const EIP155NetworkImageIds = {
  // Ethereum
  1: "692ed6ba-e569-459a-556a-776476829e00",
  // Arbitrum
  42161: "600a9a04-c1b9-42ca-6785-9b4b6ff85200",
  // Avalanche
  43114: "30c46e53-e989-45fb-4549-be3bd4eb3b00",
  // Binance Smart Chain
  56: "93564157-2e8e-4ce7-81df-b264dbee9b00",
  // Fantom
  250: "06b26297-fe0c-4733-5d6b-ffa5498aac00",
  // Optimism
  10: "ab9c186a-c52f-464b-2906-ca59d760a400",
  // Polygon
  137: "41d04d42-da3b-4453-8506-668cc0727900",
  // Gnosis
  100: "02b53f6a-e3d4-479e-1cb4-21178987d100",
  // Evmos
  9001: "f926ff41-260d-4028-635e-91913fc28e00",
  // ZkSync
  324: "b310f07f-4ef7-49f3-7073-2a0a39685800",
  // Filecoin
  314: "5a73b3dd-af74-424e-cae0-0de859ee9400",
  // Iotx
  4689: "34e68754-e536-40da-c153-6ef2e7188a00",
  // Metis,
  1088: "3897a66d-40b9-4833-162f-a2c90531c900",
  // Moonbeam
  1284: "161038da-44ae-4ec7-1208-0ea569454b00",
  // Moonriver
  1285: "f1d73bb6-5450-4e18-38f7-fb6484264a00",
  // Zora
  7777777: "845c60df-d429-4991-e687-91ae45791600",
  // Celo
  42220: "ab781bbc-ccc6-418d-d32d-789b15da1f00",
  // Base
  8453: "7289c336-3981-4081-c5f4-efc26ac64a00",
  // Aurora
  1313161554: "3ff73439-a619-4894-9262-4470c773a100",
};

// Maps connector name -> `asset_id`
const ConnectorImageIds = {
  coinbaseWallet: "0c2840c3-5b04-4c44-9661-fbd4b49e1800",
  safe: "461db637-8616-43ce-035a-d89b8a1d5800",
  ledger: "54a1aa77-d202-4f8d-0fb2-5d2bb6db0300",
  walletConnect: "ef1a1fcf-7fe8-4d69-bd6d-fda1345b4400",
  injected: "07ba87ed-43aa-4adf-4540-9e6a2b9cae00",
};