Getting started with Mnemonic

Integrating your product with Mnemonic is so easy, it shouldn't take more than 10 minutes.

Get an API key

Mnemonic is currently in beta, in order to sign up and get access please follow instructions on this page. We want to hear from you about your project and how Mnemonic can help you reach your goals.

Once signed up you will receive your API key, which you can use to start sending requests and building your application.

See examples of how to use your API key to start making requests.

Make first request

The simplest way to start interacting with Mnemonic APIs is using REST protocol or even your favourite command-line.

Here is an example you can run from your terminal to retrieve NFTs owned by the specified wallet address:

Using REST

curlpython
Copy
Copied
$ curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/by_contract/0x60e4d786628fea6478f785a6d7e704777c86a7c6?limit=5' \
  -H 'X-API-Key: <API KEY>'
Copy
Copied
import requests # requires `pip install requests`

result = requests.get(
    'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/by_contract/0x60e4d786628fea6478f785a6d7e704777c86a7c6?limit=5',
    headers={'x-api-key': 'YOUR_API_KEY_HERE'}
).json()

Using gRPC / Protobuf

The easiest way to test gRPC/Protobuf APIs is to use grpcurl command.

Make sure you checked out the latest Protobuf definitions for Mnemonic APIs from our public Buf repository.

Result

Copy
Copied
{
  "nfts": [
    {
      "contractAddress": "0x049aba7510f45ba5b64ea9e658e342f904db358d",
      "tokenId": "13681194913005736661451703431383239036076055651263216114967745469462720029232",
      "type": "TYPE_ERC721",
      "metadata": {
        "metadataUri": {
          "uri": "https://metadata.unstoppabledomains.com/metadata/13681194913005736661451703431383239036076055651263216114967745469462720029232",
          "mimeType": "application/json"
        },
        "name": "wallet",
        "description": "This is the only TLD on the Unstoppable registry. It's not owned by anyone.",
        "image": {
          "uri": "https://ethereum.cdn-proxy.mnemonichq.com/0x049aba7510f45ba5b64ea9e658e342f904db358d/13681194913005736661451703431383239036076055651263216114967745469462720029232",
          "uriOriginal": "https://metadata.unstoppabledomains.com/image-src/wallet.svg",
          "mimeType": "image/svg+xml"
        }
      },
      "mintEvent": {
        "txHash": "0xa6a5504aae144ca1728b59604b9fa10b7947f7cc495dc63f2e4589584be935cb",
        "logIndex": "307",
        "blockTimestamp": "2021-07-07T10:09:32Z"
      }
    },
    {
      "contractAddress": "0x049aba7510f45ba5b64ea9e658e342f904db358d",
      "tokenId": "16337138753721533047366280587793949485382852539298099954095419838788728323117",
      "type": "TYPE_ERC721",
      "metadata": {
        "metadataUri": {
          "uri": "https://metadata.unstoppabledomains.com/metadata/16337138753721533047366280587793949485382852539298099954095419838788728323117",
          "mimeType": "application/json"
        },
        "name": "x",
        "description": "This is the only TLD on the Unstoppable registry. It's not owned by anyone.",
        "image": {
          "uri": "https://ethereum.cdn-proxy.mnemonichq.com/0x049aba7510f45ba5b64ea9e658e342f904db358d/16337138753721533047366280587793949485382852539298099954095419838788728323117",
          "uriOriginal": "https://metadata.unstoppabledomains.com/image-src/x.svg",
          "mimeType": "image/svg+xml"
        }
      },
      "mintEvent": {
        "txHash": "0xa6a5504aae144ca1728b59604b9fa10b7947f7cc495dc63f2e4589584be935cb",
        "logIndex": "311",
        "blockTimestamp": "2021-07-07T10:09:32Z"
      }
    }
  ]
}

Nest steps

There's a lot you can build with Mnemonic API as well: you can obtain fresh pricing information about any collection, surface mooning collections by looking at Top Collections, find out who the Current Owners, and much more!