Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

Foundational

Foundational API gives you access to every foundational NFT datapoint imaginable. This includes details about contracts, tokens, transfers and much more.

Contracts List

Returns a list of contracts ordered by the block mint timestamp.

Request
Security:
ApiKeyAuth
query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort direction (sort key = timestamp, default = ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
blockTimestampGt
string <date-time>

Filter by minimal block timestamp, using "greater" comparison. This filter exludes contracts matching given block timestamp exactly. Useful to get updates only.

contractTypes
Array of strings

Filter by contract types.

  • TYPE_UNSPECIFIED: Unset is a system value (shouldn't be present in real data).
  • TYPE_ERC20: ERC20 type (fungible tokens).
  • TYPE_ERC721: ERC721 type.
  • TYPE_ERC1155: ERC1155 type.
  • TYPE_ERC721_LEGACY: ERC721 legacy type.
  • TYPE_CRYPTOPUNKS: Cryptopunks contract type.
Items Enum: "TYPE_ERC20" "TYPE_ERC721" "TYPE_ERC1155" "TYPE_ERC721_LEGACY" "TYPE_CRYPTOPUNKS"
Responses
200

A successful response.

get/foundational/v1beta2/contracts
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/contracts?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&blockTimestampGt=2019-08-24T14%3A15%3A22Z&contractTypes=TYPE_ERC20' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "contracts": [
    • {
      • "mintEvent": {
        • "blockTimestamp": "2019-08-24T14:15:22Z",
        • "txHash": "string",
        • "minterAddress": "string"
        },
      • "name": "string",
      • "symbol": "string",
      • "decimals": 0,
      • "address": "string",
      • "types": [
        • "TYPE_ERC20"
        ]
      }
    ]
}

Contract Details

Returns full details about the contract, including the decoded type and metadata, if defined by the contract.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name).

Responses
200

A successful response.

get/foundational/v1beta2/contracts/{contractAddress}/details
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/contracts/:contractAddress/details \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "contract": {
    • "mintEvent": {
      • "blockTimestamp": "2019-08-24T14:15:22Z",
      • "txHash": "string",
      • "minterAddress": "string"
      },
    • "name": "string",
    • "symbol": "string",
    • "decimals": 0,
    • "address": "string",
    • "types": [
      • "TYPE_ERC20"
      ]
    }
}

NFTs by Contract

Returns a list of the NFTs tracked by a given contract.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort direction (sort key = timestamp, default = ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
blockTimestampGt
string <date-time>

Filter by minimal block timestamp, using "greater" comparison. This filter exludes rows matching given timestamp exactly.

traits
Array of strings

Filter by token traits. For multiple filters with the same trait name, the values are OR'd (if string values). For different trait names, the filter returns values that have all the values.

The format of each trait filter will be the name of the trait followed by one of the allowed comparison operators (=, >=, <=) and the value of that trait to filter against. For numeric/date traits, users are allowed to pass in upto two filters (one >=, one <=) for filtering within a range.

Note: The = operator is available only for string traits, and the >=, <= comparison operators are available for only numeric and date traits.

Valid filters: 

{"color=red", "color=yellow", "experience>=5", "experience<=10", "birthday>=2022-09-30T15:33:50+00:00"}

For eg. for the above array of filters, the endpoint will return all tokens that have: (color = red OR color = yellow) AND (experience >= 1 and experience <= 5) AND birthday>=2022-09-30T15:33:50+00:00

Responses
200

A successful response.

get/foundational/v1beta2/nfts/by_contract/{contractAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/by_contract/:contractAddress?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&blockTimestampGt=2019-08-24T14%3A15%3A22Z&traits=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nfts": [
    • {
      • "contractAddress": "string",
      • "tokenId": "string",
      • "type": "TYPE_ERC721",
      • "metadata": {
        • "metadataUri": {
          • "uri": "string",
          • "mimeType": "string"
          },
        • "name": "string",
        • "description": "string",
        • "image": {
          • "uri": "string",
          • "uriOriginal": "string",
          • "mimeType": "string"
          }
        },
      • "mintEvent": {
        • "txHash": "string",
        • "logIndex": "string",
        • "blockTimestamp": "2019-08-24T14:15:22Z"
        },
      • "collection": {
        • "name": "string"
        }
      }
    ]
}

NFTs by Minter

Returns a list of the NFTs minted by a given address.

Request
Security:
ApiKeyAuth
path Parameters
minterAddress
required
string

Filter by minter address (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

contractAddress
string

Filter by contract address (or ENS name).

tokenTypes
Array of strings

Filter by the NFT types.

  • TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TYPE_ERC721: ERC721 type.
  • TYPE_ERC1155: ERC1155 type.
  • TYPE_ERC721_LEGACY: ERC721 legacy type.
  • TYPE_CRYPTOPUNKS: Cryptopunks type.
Items Enum: "TYPE_ERC721" "TYPE_ERC1155" "TYPE_ERC721_LEGACY" "TYPE_CRYPTOPUNKS"
blockTimestampGt
string <date-time>

Filter by minimal block timestamp, using "greater" comparison. This filter exludes rows matching given timestamp exactly.

Responses
200

A successful response.

get/foundational/v1beta2/nfts/by_minter/{minterAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/by_minter/:minterAddress?limit=string&offset=string&contractAddress=string&tokenTypes=TYPE_ERC721&blockTimestampGt=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nfts": [
    • {
      • "contractAddress": "string",
      • "tokenId": "string",
      • "type": "TYPE_ERC721",
      • "metadata": {
        • "metadataUri": {
          • "uri": "string",
          • "mimeType": "string"
          },
        • "name": "string",
        • "description": "string",
        • "image": {
          • "uri": "string",
          • "uriOriginal": "string",
          • "mimeType": "string"
          }
        },
      • "mintEvent": {
        • "txHash": "string",
        • "logIndex": "string",
        • "blockTimestamp": "2019-08-24T14:15:22Z"
        },
      • "collection": {
        • "name": "string"
        }
      }
    ]
}

NFTs by Owner

Returns a list of the NFTs owned by a given address.

Request
Security:
ApiKeyAuth
path Parameters
ownerAddress
required
string

Filter by owner address (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

contractAddress
string

Filter by contract address (or ENS name).

tokenTypes
Array of strings

Filter by the NFT types.

  • TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TYPE_ERC721: ERC721 type.
  • TYPE_ERC1155: ERC1155 type.
  • TYPE_ERC721_LEGACY: ERC721 legacy type.
  • TYPE_CRYPTOPUNKS: Cryptopunks type.
Items Enum: "TYPE_ERC721" "TYPE_ERC1155" "TYPE_ERC721_LEGACY" "TYPE_CRYPTOPUNKS"
Responses
200

A successful response.

get/foundational/v1beta2/nfts/by_owner/{ownerAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/by_owner/:ownerAddress?limit=string&offset=string&contractAddress=string&tokenTypes=TYPE_ERC721' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nfts": [
    • {
      • "nft": {
        • "contractAddress": "string",
        • "tokenId": "string",
        • "type": "TYPE_ERC721",
        • "metadata": {
          • "metadataUri": {
            • "uri": "string",
            • "mimeType": "string"
            },
          • "name": "string",
          • "description": "string",
          • "image": {
            • "uri": "string",
            • "uriOriginal": "string",
            • "mimeType": "string"
            }
          },
        • "mintEvent": {
          • "txHash": "string",
          • "logIndex": "string",
          • "blockTimestamp": "2019-08-24T14:15:22Z"
          },
        • "collection": {
          • "name": "string"
          }
        },
      • "quantity": "string"
      }
    ]
}

NFT Details

Returns full details about the NFT including structured metadata, owners count, available quantity (for ERC-1155), last sale details.

Last sale details are taken from the last paid transfer, for which the the price paid has been successfully attributed.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name) that tracks NFT.

tokenId
required
string

Token ID.

Responses
200

A successful response.

get/foundational/v1beta2/nfts/{contractAddress}/{tokenId}/details
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/:contractAddress/:tokenId/details \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nft": {
    • "contractAddress": "string",
    • "tokenId": "string",
    • "type": "TYPE_ERC721",
    • "metadata": {
      • "metadataUri": {
        • "uri": "string",
        • "mimeType": "string"
        },
      • "name": "string",
      • "description": "string",
      • "image": {
        • "uri": "string",
        • "uriOriginal": "string",
        • "mimeType": "string"
        }
      },
    • "mintEvent": {
      • "txHash": "string",
      • "logIndex": "string",
      • "blockTimestamp": "2019-08-24T14:15:22Z"
      },
    • "collection": {
      • "name": "string"
      }
    },
  • "metrics": {
    • "quantity": "string",
    • "ownerCount": "string"
    },
  • "lastSale": {
    • "blockchainEvent": {
      • "txHash": "string",
      • "logIndex": "string",
      • "seqIndex": "string",
      • "blockNumber": "string",
      • "blockTimestamp": "2019-08-24T14:15:22Z"
      },
    • "recipientPaid": {
      • "totalNative": "string",
      • "totalUsd": "string",
      • "nativeTransfersTotal": "string",
      • "fungibleTransfersTotal": "string",
      • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
      • "fungibleTotals": [
        • {
          • "contractAddress": "string",
          • "totalNormalized": "string"
          }
        ]
      }
    }
}

NFT Metadata [deprecated]Deprecated

Returns full metadata of the given NFT.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name) that tracks NFT.

tokenId
required
string

Token ID.

Responses
200

A successful response.

get/foundational/v1beta2/nfts/{contractAddress}/{tokenId}/metadata
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/:contractAddress/:tokenId/metadata \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "metadata": {
    • "metadataUri": {
      • "uri": "string",
      • "mimeType": "string"
      },
    • "name": "string",
    • "description": "string",
    • "image": {
      • "uri": "string",
      • "uriOriginal": "string",
      • "mimeType": "string"
      },
    • "raw": "string",
    • "indexedAt": "2019-08-24T14:15:22Z",
    • "quantity": "string",
    • "ownerCount": "string",
    • "collectionName": "string"
    }
}

NFT Owners

Returns a list of the NFT owners including the quantity owned.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name) that tracks NFT.

tokenId
required
string

Token ID.

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

Responses
200

A successful response.

get/foundational/v1beta2/nfts/{contractAddress}/{tokenId}/owners
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/:contractAddress/:tokenId/owners?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "owners": [
    • {
      • "address": "string",
      • "quantity": "string"
      }
    ]
}

NFT Raw Metadata

Returns raw metadata of the given NFT as received from the metadata URI.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name) that tracks NFT.

tokenId
required
string

Token ID.

Responses
200

A successful response.

get/foundational/v1beta2/nfts/{contractAddress}/{tokenId}/raw_metadata
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/:contractAddress/:tokenId/raw_metadata \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "metadata": {
    • "raw": "string",
    • "indexedAt": "2019-08-24T14:15:22Z"
    }
}

NFT Traits [deprecated]Deprecated

Returns all traits of the given NFT.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

tokenId
required
string

Token ID.

query Parameters
limit
string <uint64>

How many trait rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

Responses
200

A successful response.

get/foundational/v1beta2/nfts/{contractAddress}/{tokenId}/traits
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/:contractAddress/:tokenId/traits?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "traits": [
    • {
      • "name": "string",
      • "displayType": "DISPLAY_TYPE_PROPERTY",
      • "valueType": "VALUE_TYPE_NUMERIC",
      • "valueNumeric": {
        • "value": 0,
        • "min": 0,
        • "max": 0
        },
      • "valueString": {
        • "value": "string",
        • "nftsCount": "string",
        • "nftsPercentage": 0
        },
      • "valueDate": {
        • "value": "2019-08-24T14:15:22Z",
        • "min": "2019-08-24T14:15:22Z",
        • "max": "2019-08-24T14:15:22Z"
        }
      }
    ]
}

NFT Traits

Returns all traits of the given NFT.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

tokenId
required
string

Token ID.

query Parameters
limit
string <uint64>

How many trait rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

Responses
200

A successful response.

get/foundational/v1beta2/nfts/{contractAddress}/{tokenId}/traits/all
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/nfts/:contractAddress/:tokenId/traits/all?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "traits": [
    • {
      • "name": "string",
      • "displayType": "DISPLAY_TYPE_PROPERTY",
      • "valueString": "string",
      • "valueNumeric": 0,
      • "valueDate": "2019-08-24T14:15:22Z"
      }
    ]
}

Transfers by Tx Hash

Returns a list of NFT, native and fungible token transfers by the transaction hash (for NFT-related transactions only).

Request
Security:
ApiKeyAuth
path Parameters
txHash
required
string

Transaction hash.

Responses
200

A successful response.

get/foundational/v1beta2/transfers/all/by_tx_hash/{txHash}
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/transfers/all/by_tx_hash/:txHash \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nftTransfers": [
    • {
      • "blockchainEvent": {
        • "txHash": "string",
        • "logIndex": "string",
        • "seqIndex": "string",
        • "blockNumber": "string",
        • "blockTimestamp": "2019-08-24T14:15:22Z"
        },
      • "contractAddress": "string",
      • "tokenId": "string",
      • "tokenType": "TYPE_ERC721",
      • "quantity": "string",
      • "sender": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "senderReceived": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "recipient": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "recipientPaid": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "labels": [
        • "LABEL_MINT"
        ]
      }
    ],
  • "nativeTransfers": [
    • {
      • "fromAddress": "string",
      • "toAddress": "string",
      • "valueRaw": "string",
      • "valueNormalized": "string"
      }
    ],
  • "fungibleTransfers": [
    • {
      • "fromAddress": "string",
      • "toAddress": "string",
      • "contractAddress": "string",
      • "valueRaw": "string",
      • "valueNormalized": "string",
      • "valueNative": "string"
      }
    ]
}

Transfers of NFTs

Returns a list of the NFT transfers by various filters.

Request
Security:
ApiKeyAuth
query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort direction (sort key = timestamp, default = descending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
blockTimestampGt
string <date-time>

Filter by minimal block timestamp, useful to get updates since last known transfer. The filter uses "greater" comparison and excludes transfers with given timestamp, this allows getting only new transfers.

blockTimestampLte
string <date-time>

Filter by maximum block timestamp. The filter uses "less than or equal" comparison and includes transfers with given timestamp.

contractAddress
string

Filter by NFT contract address (or ENS name).

tokenId
string

Filter by NFT Token ID.

tokenTypes
Array of strings

Filter by token types (any of).

  • TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TYPE_ERC721: ERC721 type.
  • TYPE_ERC1155: ERC1155 type.
  • TYPE_ERC721_LEGACY: ERC721 legacy type.
  • TYPE_CRYPTOPUNKS: Cryptopunks type.
Items Enum: "TYPE_ERC721" "TYPE_ERC1155" "TYPE_ERC721_LEGACY" "TYPE_CRYPTOPUNKS"
senderAddress
string

Filter by sender address (or ENS name).

recipientAddress
string

Filter by recipient address (or ENS name).

labelsAny
Array of strings

Filter by labels - multiple label types can be selected. Labels that include "MARKETPLACE", indicates the specific marketplace where a transaction occurred.

  • LABEL_UNSPECIFIED: Undefined (should not be present in real data).
  • LABEL_MINT: Transfer is labeled a mint when sender address is 0x0000000000000000000000000000000000000000 or 0x000000000000000000000000000000000000dead.
  • LABEL_BURN: Transfer is labeled a burn when recipient is 0x0000000000000000000000000000000000000000 or 0x000000000000000000000000000000000000dead.
  • LABEL_SALE: Transfer is labeled a sale when it is neither a burn nor a mint and seller has incoming native or fungible token transfers inside the same transaction. Also, total value of all incoming and outgoing seller native and fungible token transfers should be greater than zero.
  • LABEL_TRANSFER: Transfer is labeled a transfer when it is neither a burn, mint, or sale.
  • LABEL_SWAP: Transfer is labeled a swap when:
    • there are no mints and burns inside the transaction;
    • there is at least one user who received and sent different tokens;
  • LABEL_BUNDLE: Transfer is labeled a bundle when:
    • there are no mints and burns inside the transaction;
    • at least two different tokens were transferred;
    • it is not a swap;
Items Enum: "LABEL_MINT" "LABEL_BURN" "LABEL_SALE" "LABEL_TRANSFER" "LABEL_SWAP" "LABEL_BUNDLE" "LABEL_MARKETPLACE_OPENSEA" "LABEL_MARKETPLACE_X2Y2" "LABEL_MARKETPLACE_GEMSWAP" "LABEL_MARKETPLACE_RARIBLE" "LABEL_MARKETPLACE_LOOKSRARE" "LABEL_MARKETPLACE_SUPERRARE" "LABEL_MARKETPLACE_CRYPTOPUNKS" "LABEL_MARKETPLACE_ARTBLOCKS" "LABEL_MARKETPLACE_DECENTRALAND" "LABEL_MARKETPLACE_OKEX" "LABEL_MARKETPLACE_BITKEEP" "LABEL_MARKETPLACE_TREASURELAND" "LABEL_MARKETPLACE_ELEMENT" "LABEL_MARKETPLACE_TOFU" "LABEL_MARKETPLACE_ONEPLANET" "LABEL_MARKETPLACE_PLAYDAPP" "LABEL_MARKETPLACE_MAGICEDEN" "LABEL_MARKETPLACE_AAVEGOTCHI" "LABEL_MARKETPLACE_BLUR"
Responses
200

A successful response.

get/foundational/v1beta2/transfers/nft
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/foundational/v1beta2/transfers/nft?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&blockTimestampGt=2019-08-24T14%3A15%3A22Z&blockTimestampLte=2019-08-24T14%3A15%3A22Z&contractAddress=string&tokenId=string&tokenTypes=TYPE_ERC721&senderAddress=string&recipientAddress=string&labelsAny=LABEL_MINT' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nftTransfers": [
    • {
      • "blockchainEvent": {
        • "txHash": "string",
        • "logIndex": "string",
        • "seqIndex": "string",
        • "blockNumber": "string",
        • "blockTimestamp": "2019-08-24T14:15:22Z"
        },
      • "contractAddress": "string",
      • "tokenId": "string",
      • "tokenType": "TYPE_ERC721",
      • "quantity": "string",
      • "sender": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "senderReceived": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "recipient": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "recipientPaid": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "labels": [
        • "LABEL_MINT"
        ]
      }
    ]
}

Collection Analytics

The service provides the ability to get collection and owners statistics, pricing and trading information.

Top Collections

Returns a list of the top collections by a given metric.

Request
Security:
ApiKeyAuth
path Parameters
metric
required
string

Metric for the collections ranking.

Enum: "METRIC_SALES_VOLUME" "METRIC_SALES_QUANTITY" "METRIC_MAX_PRICE" "METRIC_AVG_PRICE"
duration
required
string

Time duration for the analysis.

Enum: "DURATION_1_DAY" "DURATION_7_DAYS" "DURATION_30_DAYS" "DURATION_365_DAYS"
query Parameters
limit
string <uint64>

How many rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

Responses
200

A successful response.

get/collections/v1beta2/top/{metric}/{duration}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/top/:metric/:duration?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "collection": {
        • "contractAddress": "string",
        • "name": "string"
        },
      • "metricValue": "string"
      }
    ]
}

Collection Metadata

Returns collection metrics (counts, total volumes) and metadata from on-chain and off-chain sources. (Collection metadata only available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

query Parameters
includeStats
boolean

By default values for NFTs count, owners count and sales volume are returned as zeroes to substantially improves response time. Enable this flag if you need real statistic values.

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/metadata
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/metadata?includeStats=true' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "name": "string",
  • "types": [
    • "TYPE_ERC20"
    ],
  • "tokensCount": "string",
  • "ownersCount": "string",
  • "salesVolume": "string",
  • "metadata": [
    • {
      • "type": "TYPE_BANNER_IMAGE_URL",
      • "value": "string"
      }
    ]
}

Owners Count

Returns owners count time services for a collection.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

duration
required
string

Time duration for the analysis.

Enum: "DURATION_1_DAY" "DURATION_7_DAYS" "DURATION_30_DAYS" "DURATION_365_DAYS"
groupByPeriod
required
string

Aggregation period for the analysis.

Depending on the requested duration following minimal values are allowed:

  • duration = 1 day, minimum allowed value is 15 minutes;
  • duration = 7 days, minimum allowed value is 1 hour;
  • duration = 30 days, minimum allowed value is 1 day;
  • duration = 365 days, minimum allowed value is 1 day.
Enum: "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
query Parameters
timestampLt
string <date-time>

Final timestamp for the analysis.

Default is today at 00:00:00. Final timestamp is excluded from the result date, while start timestamp is included.

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/owners_count/{duration}/{groupByPeriod}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/owners_count/:duration/:groupByPeriod?timestampLt=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "dataPoints": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "count": "string"
      }
    ]
}

Owners List

Returns a list of the current owner addresses for a collection.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

query Parameters
limit
string <uint64>

How many rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort direction (sort key = owned_count, default = descending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/owners_list
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/owners_list?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "owner": [
    • {
      • "address": "string",
      • "ownedQuantity": "string"
      }
    ]
}

Token Prices

Returns token prices (minimum, maximum, average) time series for a collection. Note: Prices below 0.01 (native token) will not be included in this data. Prices below this value often represent what are effectively transfers rather than real sales.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

duration
required
string

Time duration for the analysis.

Enum: "DURATION_1_DAY" "DURATION_7_DAYS" "DURATION_30_DAYS" "DURATION_365_DAYS"
groupByPeriod
required
string

Aggregation period for the analysis.

Depending on the requested duration following minimal values are allowed:

  • duration = 1 day, minimum allowed value is 15 minutes;
  • duration = 7 days, minimum allowed value is 1 hour;
  • duration = 30 days, minimum allowed value is 1 day;
  • duration = 365 days, minimum allowed value is 1 day.
Enum: "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
query Parameters
timestampLt
string <date-time>

Final timestamp for the analysis.

Default is today at 00:00:00. Final timestamp is excluded from the result date, while start timestamp is included.

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/prices/{duration}/{groupByPeriod}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/prices/:duration/:groupByPeriod?timestampLt=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "dataPoints": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "min": "string",
      • "max": "string",
      • "avg": "string"
      }
    ]
}

Sales Volume

Returns sales volume and count time series for a collection. Note: Prices below 0.01 (native token) will not be included in this data. Prices below this value often represent what are effectively transfers rather than real sales.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

duration
required
string

Time duration for the analysis.

Enum: "DURATION_1_DAY" "DURATION_7_DAYS" "DURATION_30_DAYS" "DURATION_365_DAYS"
groupByPeriod
required
string

Aggregation period for the analysis.

Depending on the requested duration following minimal values are allowed:

  • duration = 1 day, minimum allowed value is 15 minutes;
  • duration = 7 days, minimum allowed value is 1 hour;
  • duration = 30 days, minimum allowed value is 1 day;
  • duration = 365 days, minimum allowed value is 1 day.
Enum: "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
query Parameters
timestampLt
string <date-time>

Final timestamp for the analysis.

Default is today at 00:00:00. Final timestamp is excluded from the result date, while start timestamp is included.

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/sales_volume/{duration}/{groupByPeriod}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/sales_volume/:duration/:groupByPeriod?timestampLt=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "dataPoints": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "quantity": "string",
      • "volume": "string"
      }
    ]
}

Token Supply

Returns token supply time services for a collection.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

duration
required
string

Time duration for the analysis.

Enum: "DURATION_1_DAY" "DURATION_7_DAYS" "DURATION_30_DAYS" "DURATION_365_DAYS"
groupByPeriod
required
string

Aggregation period for the analysis.

Depending on the requested duration following minimal values are allowed:

  • duration = 1 day, minimum allowed value is 15 minutes;
  • duration = 7 days, minimum allowed value is 1 hour;
  • duration = 30 days, minimum allowed value is 1 day;
  • duration = 365 days, minimum allowed value is 1 day.
Enum: "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
query Parameters
timestampLt
string <date-time>

Final timestamp for the analysis.

Default is today at 00:00:00. Final timestamp is excluded from the result date, while start timestamp is included.

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/supply/{duration}/{groupByPeriod}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/supply/:duration/:groupByPeriod?timestampLt=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "dataPoints": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "minted": "string",
      • "burned": "string",
      • "totalMinted": "string",
      • "totalBurned": "string"
      }
    ]
}

Collection Traits (numeric)

Returns aggregated numeric traits for the collection. The response includes traits with their minimum and maximum values. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

query Parameters
limit
string <uint64>

How many rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/traits/numeric
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/traits/numeric?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "traits": [
    • {
      • "name": "string",
      • "displayType": "DISPLAY_TYPE_PROPERTY",
      • "valueMin": 0,
      • "valueMax": 0
      }
    ]
}

Collection Traits (string)

Returns aggregated string traits for the collection. The response includes all possible values for each of the string traits. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

query Parameters
limit
string <uint64>

How many rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

maxDistinctValuesPerTrait
integer <int64>

If more than max number of distinct trait values exist, then the traits returned are the most common ones (by count). Defaults to 100, maximum value is UINT32_MAX.

Responses
200

A successful response.

get/collections/v1beta2/{contractAddress}/traits/string
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/collections/v1beta2/:contractAddress/traits/string?limit=string&offset=string&maxDistinctValuesPerTrait=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "traits": [
    • {
      • "name": "string",
      • "value": "string",
      • "nftsCount": "string",
      • "nftsPercentage": 0
      }
    ]
}

Wallet Intelligence

WalletsService provides the ability to get a list of NFTs or Transfers where a specific Wallet is involved.

ENS by Address

Returns the current ENS entity(s) corresponding to a given Ethereum address, if it exists.

Request
Security:
ApiKeyAuth
path Parameters
address
required
string

An Ethereum address.

Responses
200

A successful response.

get/wallets/v1beta2/ens/by_address/{address}
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/ens/by_address/:address \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "entities": [
    • {
      • "name": "string",
      • "resolvedAddress": "string",
      • "validFromTimestamp": "2019-08-24T14:15:22Z",
      • "validTillTimestamp": "2019-08-24T14:15:22Z",
      • "parentName": "string",
      • "matchesReverseRecord": true
      }
    ]
}

ENS History by Address

Returns all of the historical ENS entities corresponding to a given Ethereum address.

Request
Security:
ApiKeyAuth
path Parameters
address
required
string

An Ethereum address.

Responses
200

A successful response.

get/wallets/v1beta2/ens/by_address/{address}/history
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/ens/by_address/:address/history \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "entities": [
    • {
      • "name": "string",
      • "resolvedAddress": "string",
      • "validFromTimestamp": "2019-08-24T14:15:22Z",
      • "validTillTimestamp": "2019-08-24T14:15:22Z"
      }
    ]
}

ENS by Name

Returns the current ENS entity corresponding to a given ENS Name, if it exists.

Request
Security:
ApiKeyAuth
path Parameters
name
required
string

An ENS name.

Responses
200

A successful response.

get/wallets/v1beta2/ens/by_name/{name}
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/ens/by_name/:name \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "entity": {
    • "name": "string",
    • "resolvedAddress": "string",
    • "validFromTimestamp": "2019-08-24T14:15:22Z",
    • "validTillTimestamp": "2019-08-24T14:15:22Z",
    • "parentName": "string",
    • "matchesReverseRecord": true
    }
}

ENS History by Name

Returns all of the historical ENS entities corresponding to a given ENS Name.

Request
Security:
ApiKeyAuth
path Parameters
name
required
string

An ENS name.

Responses
200

A successful response.

get/wallets/v1beta2/ens/by_name/{name}/history
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/ens/by_name/:name/history \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "entities": [
    • {
      • "name": "string",
      • "resolvedAddress": "string",
      • "validFromTimestamp": "2019-08-24T14:15:22Z",
      • "validTillTimestamp": "2019-08-24T14:15:22Z"
      }
    ]
}

[BETA] NFTs Pricing Details

Returns a list of NFTs for a given wallet together with details around their floor price and last sale price. Allows filtering spam in/out, and returns a spam identification flag. (Spam filtering and floor prices are available only on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
walletAddress
required
string

Filter by wallet address (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort contract address and token id direction (default = ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
contractAddress
string

Filter by NFT contract address (optional).

marketplaceId
string

Filter by specific marketplace. If not set, returns all marketplaces.

  • MARKETPLACE_ID_UNSPECIFIED: Unspecified, also is a default value.
  • MARKETPLACE_ID_OPENSEA: OpenSea Marketplace.
Value: "MARKETPLACE_ID_OPENSEA"
floorPrice.min
number <double>

If set, represent the result will only contain nfts that are actively listed with prices higher than the min price.

floorPrice.max
number <double>

If set, represent the result will only contain nfts that are actively listed with prices lower than the max price.

floorPrice.denomination
string

What denomination the min and max prices are set in.

Enum: "DENOMINATION_USD" "DENOMINATION_NATIVE"
traits
Array of strings

Filter by token traits (optional). For multiple filters with the same trait name, the values are OR'd (if string values). For different trait names, the filter returns values that have all the values.

The format of each trait filter will be the name of the trait followed by one of the allowed comparison operators (=, >=, <=) and the value of that trait to filter against. For numeric/date traits, users are allowed to pass in upto two filters (one >=, one <=) for filtering within a range.

Note: The = operator is available only for string traits, and the >=, <= comparison operators are available for only numeric and date traits.

Valid filters: 

{"color=red", "color=yellow", "experience>=5", "experience<=10", "birthday>=2022-09-30T15:33:50+00:00"}

For eg. for the above array of filters, the endpoint will return all tokens that have: (color = red OR color = yellow) AND (experience >= 1 and experience <= 5) AND birthday>=2022-09-30T15:33:50+00:00

returnOnlyListed
boolean

If true, return only tokens that have active listings (default = false).

spam
string

Spam filter.

  • SPAM_FILTER_UNSPECIFIED: Return all tokens (default).
  • SPAM_FILTER_EXCLUDE: Exclude spam.
  • SPAM_FILTER_ONLY: Return only spam.
Enum: "SPAM_FILTER_EXCLUDE" "SPAM_FILTER_ONLY"
Responses
200

A successful response.

get/wallets/v1beta2/priced_nfts/{walletAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/priced_nfts/:walletAddress?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&contractAddress=string&marketplaceId=MARKETPLACE_ID_OPENSEA&floorPrice.min=0&floorPrice.max=0&floorPrice.denomination=DENOMINATION_USD&traits=string&returnOnlyListed=true&spam=SPAM_FILTER_EXCLUDE' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nfts": [
    • {
      • "nft": {
        • "nft": {
          • "contractAddress": "string",
          • "tokenId": "string",
          • "type": "TYPE_ERC721",
          • "metadata": {
            • "metadataUri": {
              • "uri": "string",
              • "mimeType": "string"
              },
            • "name": "string",
            • "description": "string",
            • "image": {
              • "uri": "string",
              • "uriOriginal": "string",
              • "mimeType": "string"
              }
            },
          • "mintEvent": {
            • "txHash": "string",
            • "logIndex": "string",
            • "blockTimestamp": "2019-08-24T14:15:22Z"
            },
          • "collection": {
            • "name": "string"
            }
          },
        • "lastSalePrice": {
          • "totalNative": "string",
          • "totalUsd": "string",
          • "nativeTransfersTotal": "string",
          • "fungibleTransfersTotal": "string",
          • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
          • "fungibleTotals": [
            • {
              • "contractAddress": "string",
              • "totalNormalized": "string"
              }
            ]
          },
        • "floorPrice": {
          • "totalNative": "string",
          • "totalUsd": "string",
          • "fungibleAddress": "string",
          • "fungibleValue": "string"
          },
        • "marketplaceIds": [
          • "MARKETPLACE_ID_OPENSEA"
          ]
        },
      • "spam": true
      }
    ]
}

Collections Owned

Returns a list of collections owned by the wallet.

Request
Security:
ApiKeyAuth
path Parameters
walletAddress
required
string

Filter by wallet address (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortBy
string

Criteria to sort results by.

  • SORT_BY_UNSPECIFIED: Sort criteria not specified.
  • SORT_BY_COLLECTION_ADDRESS: Sort by collection address.
  • SORT_BY_COLLECTION_NAME: Sort by collection name.
  • SORT_BY_LAST_RECEIVED_AT: Sort by the time when the latest token is received.
Enum: "SORT_BY_COLLECTION_ADDRESS" "SORT_BY_COLLECTION_NAME" "SORT_BY_LAST_RECEIVED_AT"
sortDirection
string

Sort direction (default is ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
Responses
200

A successful response.

get/wallets/v1beta2/{walletAddress}/collections
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/:walletAddress/collections?limit=string&offset=string&sortBy=SORT_BY_COLLECTION_ADDRESS&sortDirection=SORT_DIRECTION_ASC' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "tokensCount": "string",
      • "tokensQuantity": "string",
      • "lastReceivedAt": "2019-08-24T14:15:22Z"
      }
    ]
}

NFT Transfers

Returns a list of the NFT transfers by the wallet. Allows filtering spam in/out, and returns a spam identification flag. (Spam filtering return values are supported only on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
walletAddress
required
string

Filter by wallet address (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort direction (sort key = timestamp, default = descending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
blockTimestampGt
string <date-time>

Filter by minimal block timestamp, useful to get updates since last known transfer. The filter uses "greater" comparison and excludes transfers with given timestamp, this allows getting only new transfers.

blockTimestampLte
string <date-time>

Filter by maximum block timestamp. The filter uses "less than or equal" comparison and includes transfers with given timestamp.

contractAddress
string

Filter by NFT contract address (or ENS name).

tokenId
string

Filter by NFT Token ID.

labelsAny
Array of strings

Filter by labels - multiple label types can be selected. Labels that include "MARKETPLACE", indicates the specific marketplace where a transaction occurred.

  • LABEL_UNSPECIFIED: Undefined (should not be present in real data).
  • LABEL_MINT: Transfer is labeled a mint when sender address is 0x0000000000000000000000000000000000000000 or 0x000000000000000000000000000000000000dead.
  • LABEL_BURN: Transfer is labeled a burn when recipient is 0x0000000000000000000000000000000000000000 or 0x000000000000000000000000000000000000dead.
  • LABEL_SALE: Transfer is labeled a sale when it is neither a burn nor a mint and seller has incoming native or fungible token transfers inside the same transaction. Also, total value of all incoming and outgoing seller native and fungible token transfers should be greater than zero.
  • LABEL_TRANSFER: Transfer is labeled a transfer when it is neither a burn, mint, or sale.
  • LABEL_SWAP: Transfer is labeled a swap when:
    • there are no mints and burns inside the transaction;
    • there is at least one user who received and sent different tokens;
  • LABEL_BUNDLE: Transfer is labeled a bundle when:
    • there are no mints and burns inside the transaction;
    • at least two different tokens were transferred;
    • it is not a swap;
Items Enum: "LABEL_MINT" "LABEL_BURN" "LABEL_SALE" "LABEL_TRANSFER" "LABEL_SWAP" "LABEL_BUNDLE" "LABEL_MARKETPLACE_OPENSEA" "LABEL_MARKETPLACE_X2Y2" "LABEL_MARKETPLACE_GEMSWAP" "LABEL_MARKETPLACE_RARIBLE" "LABEL_MARKETPLACE_LOOKSRARE" "LABEL_MARKETPLACE_SUPERRARE" "LABEL_MARKETPLACE_CRYPTOPUNKS" "LABEL_MARKETPLACE_ARTBLOCKS" "LABEL_MARKETPLACE_DECENTRALAND" "LABEL_MARKETPLACE_OKEX" "LABEL_MARKETPLACE_BITKEEP" "LABEL_MARKETPLACE_TREASURELAND" "LABEL_MARKETPLACE_ELEMENT" "LABEL_MARKETPLACE_TOFU" "LABEL_MARKETPLACE_ONEPLANET" "LABEL_MARKETPLACE_PLAYDAPP" "LABEL_MARKETPLACE_MAGICEDEN" "LABEL_MARKETPLACE_AAVEGOTCHI" "LABEL_MARKETPLACE_BLUR"
tokenIsSpam
string

Spam filter.

  • SPAM_FILTER_UNSPECIFIED: Return all tokens (default).
  • SPAM_FILTER_EXCLUDE: Exclude spam.
  • SPAM_FILTER_ONLY: Return only spam.
Enum: "SPAM_FILTER_EXCLUDE" "SPAM_FILTER_ONLY"
party
string

Filter by whether the wallet address is the sender, recipient, or any of them.

  • PARTY_UNSPECIFIED: Specified wallet can be or sender or recipient.
  • PARTY_SENDER: Specified wallet is a sender.
  • PARTY_RECIPIENT: Specified wallet is a recipient.
Enum: "PARTY_SENDER" "PARTY_RECIPIENT"
Responses
200

A successful response.

get/wallets/v1beta2/{walletAddress}/nft_transfers
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/:walletAddress/nft_transfers?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&blockTimestampGt=2019-08-24T14%3A15%3A22Z&blockTimestampLte=2019-08-24T14%3A15%3A22Z&contractAddress=string&tokenId=string&labelsAny=LABEL_MINT&tokenIsSpam=SPAM_FILTER_EXCLUDE&party=PARTY_SENDER' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nftTransfers": [
    • {
      • "blockchainEvent": {
        • "txHash": "string",
        • "logIndex": "string",
        • "seqIndex": "string",
        • "blockNumber": "string",
        • "blockTimestamp": "2019-08-24T14:15:22Z"
        },
      • "contractAddress": "string",
      • "tokenId": "string",
      • "quantity": "string",
      • "sender": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "senderReceived": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "recipient": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "recipientPaid": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "labels": [
        • "LABEL_MINT"
        ],
      • "tokenIsSpam": true
      }
    ]
}

NFTs Owned

Returns a list of the NFTs owned by the wallet. Allows filtering spam in/out, and returns a spam identification flag. (Spam filtering return values are supported only on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
walletAddress
required
string

Filter by wallet address (or ENS name).

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

contractAddress
string

Filter by contract address (or ENS name).

spam
string

Spam filter.

  • SPAM_FILTER_UNSPECIFIED: Return all tokens (default).
  • SPAM_FILTER_EXCLUDE: Exclude spam.
  • SPAM_FILTER_ONLY: Return only spam.
Enum: "SPAM_FILTER_EXCLUDE" "SPAM_FILTER_ONLY"
Responses
200

A successful response.

get/wallets/v1beta2/{walletAddress}/nfts
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/:walletAddress/nfts?limit=string&offset=string&contractAddress=string&spam=SPAM_FILTER_EXCLUDE' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nfts": [
    • {
      • "nft": {
        • "contractAddress": "string",
        • "tokenId": "string",
        • "type": "TYPE_ERC721",
        • "metadata": {
          • "metadataUri": {
            • "uri": "string",
            • "mimeType": "string"
            },
          • "name": "string",
          • "description": "string",
          • "image": {
            • "uri": "string",
            • "uriOriginal": "string",
            • "mimeType": "string"
            }
          },
        • "mintEvent": {
          • "txHash": "string",
          • "logIndex": "string",
          • "blockTimestamp": "2019-08-24T14:15:22Z"
          },
        • "collection": {
          • "name": "string"
          }
        },
      • "quantity": "string",
      • "spam": true
      }
    ]
}

Report Not Spam

Report that a collection or an NFT was inaccurately flagged as spam. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
walletAddress
required
string

The wallet address of the user who reported inaccuracy.

contractAddress
required
string

Contract address that tracks NFT.

query Parameters
tokenId
string

Token ID of the NFT.

feedback
string

User feedback or explanations.

Responses
200

A successful response.

get/wallets/v1beta2/{walletAddress}/report_not_spam/{contractAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/:walletAddress/report_not_spam/:contractAddress?tokenId=string&feedback=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Report Spam

Report a collection or an NFT as spam. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
walletAddress
required
string

The wallet address of the user who reported inaccuracy.

contractAddress
required
string

Contract address that tracks NFT.

query Parameters
tokenId
string

Token ID of the NFT.

feedback
string

User feedback or explanations.

Responses
200

A successful response.

get/wallets/v1beta2/{walletAddress}/report_spam/{contractAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/wallets/v1beta2/:walletAddress/report_spam/:contractAddress?tokenId=string&feedback=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Marketplaces

MarketplaceService provides the ability to get marketplace activity about NFTs from different marketplaces.

Collection/NFT Floor

Returns a floor price for the given collection or token. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address of the collection (or ENS name).

query Parameters
tokenId
string

Token ID.

marketplaceId
string

Filter by a specific marketplace.

  • MARKETPLACE_ID_UNSPECIFIED: Unspecified, also is a default value.
  • MARKETPLACE_ID_OPENSEA: OpenSea Marketplace.
Value: "MARKETPLACE_ID_OPENSEA"
Responses
200

A successful response.

get/marketplaces/v1beta2/floors/{contractAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/marketplaces/v1beta2/floors/:contractAddress?tokenId=string&marketplaceId=MARKETPLACE_ID_OPENSEA' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "price": {
    • "totalNative": "string",
    • "totalUsd": "string",
    • "fungibleAddress": "string",
    • "fungibleValue": "string"
    }
}

NFT Listings

Returns a list of active NFT listings across multiple marketplaces. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortBy
string

Sort criteria/key (default = sort by creation timestamp).

  • SORT_BY_UNSPECIFIED: Unspecified, also is a default value.
  • SORT_BY_CREATION_TIMESTAMP: Sort by the creation timestamp.
  • SORT_BY_START_TIMESTAMP: Sort by the start timestamp.
  • SORT_BY_EXPIRATION_TIMESTAMP: Sort by the expiration timestamp.
  • SORT_BY_PRICE: Sort by the price
Enum: "SORT_BY_CREATION_TIMESTAMP" "SORT_BY_START_TIMESTAMP" "SORT_BY_EXPIRATION_TIMESTAMP" "SORT_BY_PRICE"
sortDirection
string

Sort direction (sort key, default = ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
creationTimestampGt
string <date-time>

Filter by minimal listing creation timestamp, useful to get updates since last known listing. The filter uses "greater" comparison and excludes listings with given timestamp, this allows getting only new listings.

listingType
string

Filter by the type of the listing (default = any type).

  • LISTING_TYPE_UNSPECIFIED: Unspecified, is also a default value.
  • LISTING_TYPE_INDIVIDUAL_NFT: Individual NFT (a single NFT in the listing).
  • LISTING_TYPE_BUNDLE: Bundle (multiple NFTs in the same listing).
Enum: "LISTING_TYPE_INDIVIDUAL_NFT" "LISTING_TYPE_BUNDLE"
marketplaceId
string

Filter by specific marketplace. If not set, returns all marketplaces returns all marketplaces currently supported..

  • MARKETPLACE_ID_UNSPECIFIED: Unspecified, also is a default value.
  • MARKETPLACE_ID_OPENSEA: OpenSea Marketplace.
Value: "MARKETPLACE_ID_OPENSEA"
contractAddress
string

Filter by NFT contract address. The request must include either the contract address or the creator address.

tokenId
string

Filter by NFT token ID.

creatorAddress
string

Filter by the creator address or ENS name of the listing. The request must include either the contract address or the creator address.

Responses
200

A successful response.

get/marketplaces/v1beta2/listings/active
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/marketplaces/v1beta2/listings/active?limit=string&offset=string&sortBy=SORT_BY_CREATION_TIMESTAMP&sortDirection=SORT_DIRECTION_ASC&creationTimestampGt=2019-08-24T14%3A15%3A22Z&listingType=LISTING_TYPE_INDIVIDUAL_NFT&marketplaceId=MARKETPLACE_ID_OPENSEA&contractAddress=string&tokenId=string&creatorAddress=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "listings": [
    • {
      • "nft": [
        • {
          • "nft": {
            • "contractAddress": "string",
            • "tokenId": "string",
            • "type": "TYPE_ERC721",
            • "metadata": {
              • "metadataUri": {
                • "uri": null,
                • "mimeType": null
                },
              • "name": "string",
              • "description": "string",
              • "image": {
                • "uri": null,
                • "uriOriginal": null,
                • "mimeType": null
                }
              },
            • "mintEvent": {
              • "txHash": "string",
              • "logIndex": "string",
              • "blockTimestamp": "2019-08-24T14:15:22Z"
              },
            • "collection": {
              • "name": "string"
              }
            },
          • "quantity": "string"
          }
        ],
      • "listingDetails": {
        • "marketplaceId": "MARKETPLACE_ID_OPENSEA",
        • "marketplacePermalink": "string",
        • "saleType": "SALE_TYPE_FIXED_PRICE",
        • "listingType": "LISTING_TYPE_INDIVIDUAL_NFT",
        • "price": {
          • "totalNative": "string",
          • "totalUsd": "string",
          • "fungibleAddress": "string",
          • "fungibleValue": "string"
          },
        • "creatorAddress": "string",
        • "creationTimestamp": "2019-08-24T14:15:22Z",
        • "startTimestamp": "2019-08-24T14:15:22Z",
        • "expirationTimestamp": "2019-08-24T14:15:22Z"
        }
      }
    ]
}

NFT Offers

Returns a list of active NFT offers across multiple marketplaces. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortBy
string

Sort criteria/key (default = sort by creation timestamp).

  • SORT_BY_UNSPECIFIED: Unspecified, also is a default value.
  • SORT_BY_CREATION_TIMESTAMP: Sort by the creation timestamp.
  • SORT_BY_START_TIMESTAMP: Sort by the start timestamp.
  • SORT_BY_EXPIRATION_TIMESTAMP: Sort by the expiration timestamp.
  • SORT_BY_PRICE: Sort by the price
Enum: "SORT_BY_CREATION_TIMESTAMP" "SORT_BY_START_TIMESTAMP" "SORT_BY_EXPIRATION_TIMESTAMP" "SORT_BY_PRICE"
sortDirection
string

Sort direction (sort key, default = ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
creationTimestampGt
string <date-time>

Filter by minimal bid/offer creation timestamp, useful to get updates since last known offer. The filter uses "greater" comparison and excludes listings with given timestamp, this allows getting only new offers.

offerType
string

Filter by type of the offer (default = any type).

  • OFFER_TYPE_UNSPECIFIED: Unspecified, is also a default value.
  • OFFER_TYPE_OFFER_INDIVIDUAL_NFT: Regular offer.
  • OFFER_TYPE_BID_INDIVIDUAL_NFT: Offer made as a bid to an auction.
  • OFFER_TYPE_OFFER_BUNDLE: Regular offer.
  • OFFER_TYPE_BID_BUNDLE: Offer made as a bid to an auction.
  • OFFER_TYPE_COLLECTION_OFFER: Offer made to any token in the given collection.
  • OFFER_TYPE_TRAIT_OFFER: Offer made to any token in a given collection that has specific traits.
Enum: "OFFER_TYPE_OFFER_INDIVIDUAL_NFT" "OFFER_TYPE_BID_INDIVIDUAL_NFT" "OFFER_TYPE_OFFER_BUNDLE" "OFFER_TYPE_BID_BUNDLE" "OFFER_TYPE_COLLECTION_OFFER" "OFFER_TYPE_TRAIT_OFFER"
marketplaceId
string

Filter by specific marketplace. If not set, returns all marketplaces.

  • MARKETPLACE_ID_UNSPECIFIED: Unspecified, also is a default value.
  • MARKETPLACE_ID_OPENSEA: OpenSea Marketplace.
Value: "MARKETPLACE_ID_OPENSEA"
contractAddress
string

Filter by NFT contract address. The request must include either the contract address, the creator address or the recipient address.

tokenId
string

Filter by NFT token ID.

creatorAddress
string

Filter by the offer/bid maker wallet address (or ENS name). The request must include either the contract address, the creator address or the recipient address.

recipientAddress
string

Filter by the offer/bid recipient wallet address (or ENS name). The request must include either the contract address, the creator address or the recipient address.

includeOwnedTokensInCollectionOffer
boolean

If set to true and a collection offer matches the parameters of the request, then the response will return an offer for each of the tokens that the collection offers matches from the wallet of the recipient address. The value of this flag will be ignored if no recipient address is passed in.

Responses
200

A successful response.

get/marketplaces/v1beta2/offers/active
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/marketplaces/v1beta2/offers/active?limit=string&offset=string&sortBy=SORT_BY_CREATION_TIMESTAMP&sortDirection=SORT_DIRECTION_ASC&creationTimestampGt=2019-08-24T14%3A15%3A22Z&offerType=OFFER_TYPE_OFFER_INDIVIDUAL_NFT&marketplaceId=MARKETPLACE_ID_OPENSEA&contractAddress=string&tokenId=string&creatorAddress=string&recipientAddress=string&includeOwnedTokensInCollectionOffer=true' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offers": [
    • {
      • "nft": [
        • {
          • "nft": {
            • "contractAddress": "string",
            • "tokenId": "string",
            • "type": "TYPE_ERC721",
            • "metadata": {
              • "metadataUri": {
                • "uri": null,
                • "mimeType": null
                },
              • "name": "string",
              • "description": "string",
              • "image": {
                • "uri": null,
                • "uriOriginal": null,
                • "mimeType": null
                }
              },
            • "mintEvent": {
              • "txHash": "string",
              • "logIndex": "string",
              • "blockTimestamp": "2019-08-24T14:15:22Z"
              },
            • "collection": {
              • "name": "string"
              }
            },
          • "quantity": "string"
          }
        ],
      • "offerDetails": {
        • "marketplaceId": "MARKETPLACE_ID_OPENSEA",
        • "marketplacePermalink": "string",
        • "offerType": "OFFER_TYPE_OFFER_INDIVIDUAL_NFT",
        • "price": {
          • "totalNative": "string",
          • "totalUsd": "string",
          • "fungibleAddress": "string",
          • "fungibleValue": "string"
          },
        • "creatorAddress": "string",
        • "recipientAddress": "string",
        • "creationTimestamp": "2019-08-24T14:15:22Z",
        • "startTimestamp": "2019-08-24T14:15:22Z",
        • "expirationTimestamp": "2019-08-24T14:15:22Z"
        }
      }
    ]
}

[BETA] NFTs Pricing Details

Returns a list of NFTs for a given collection together with details around their floor price and last sale price. (Available on: Ethereum, Polygon)

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Filter by NFT contract address.

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

sortDirection
string

Sort token id direction (default = ascending).

  • SORT_DIRECTION_ASC: Ascending.
  • SORT_DIRECTION_DESC: Descending.
Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
marketplaceId
string

Filter by specific marketplace. If not set, returns all marketplaces.

  • MARKETPLACE_ID_UNSPECIFIED: Unspecified, also is a default value.
  • MARKETPLACE_ID_OPENSEA: OpenSea Marketplace.
Value: "MARKETPLACE_ID_OPENSEA"
floorPrice.min
number <double>

If set, represent the result will only contain nfts that are actively listed with prices higher than the min price.

floorPrice.max
number <double>

If set, represent the result will only contain nfts that are actively listed with prices lower than the max price.

floorPrice.denomination
string

What denomination the min and max prices are set in.

Enum: "DENOMINATION_USD" "DENOMINATION_NATIVE"
traits
Array of strings

Filter by token traits (optional). For multiple filters with the same trait name, the values are OR'd (if string values). For different trait names, the filter returns values that have all the values.

The format of each trait filter will be the name of the trait followed by one of the allowed comparison operators (=, >=, <=) and the value of that trait to filter against. For numeric/date traits, users are allowed to pass in upto two filters (one >=, one <=) for filtering within a range.

Note: The = operator is available only for string traits, and the >=, <= comparison operators are available for only numeric and date traits.

Valid filters: 

{"color=red", "color=yellow", "experience>=5", "experience<=10", "birthday>=2022-09-30T15:33:50+00:00"}

For eg. for the above array of filters, the endpoint will return all tokens that have: (color = red OR color = yellow) AND (experience >= 1 and experience <= 5) AND birthday>=2022-09-30T15:33:50+00:00

returnOnlyListed
boolean

If true, return only tokens that have active listings (default = false).

Responses
200

A successful response.

get/marketplaces/v1beta2/priced_nfts/{contractAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/marketplaces/v1beta2/priced_nfts/:contractAddress?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&marketplaceId=MARKETPLACE_ID_OPENSEA&floorPrice.min=0&floorPrice.max=0&floorPrice.denomination=DENOMINATION_USD&traits=string&returnOnlyListed=true' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "nfts": [
    • {
      • "nft": {
        • "contractAddress": "string",
        • "tokenId": "string",
        • "type": "TYPE_ERC721",
        • "metadata": {
          • "metadataUri": {
            • "uri": "string",
            • "mimeType": "string"
            },
          • "name": "string",
          • "description": "string",
          • "image": {
            • "uri": "string",
            • "uriOriginal": "string",
            • "mimeType": "string"
            }
          },
        • "mintEvent": {
          • "txHash": "string",
          • "logIndex": "string",
          • "blockTimestamp": "2019-08-24T14:15:22Z"
          },
        • "collection": {
          • "name": "string"
          }
        },
      • "lastSalePrice": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "nativeTransfersTotal": "string",
        • "fungibleTransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "fungibleTotals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "floorPrice": {
        • "totalNative": "string",
        • "totalUsd": "string",
        • "fungibleAddress": "string",
        • "fungibleValue": "string"
        },
      • "marketplaceIds": [
        • "MARKETPLACE_ID_OPENSEA"
        ]
      }
    ]
}

Audience Insights

AudienceInsightsService API gives access to insights related to nft collections and wallets.

Collections In Common

Returns collections in common by owners of a given collection. The method returns top 30 collections, sorted by number of common owners. Excludes tokens flagged as spam for owning wallets.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name).

Responses
200

A successful response.

get/audiences/v1beta1/common/collections/{contractAddress}
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/audiences/v1beta1/common/collections/:contractAddress \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "name": "string",
      • "minterAddress": "string",
      • "commonOwnersCount": "string",
      • "ownersCount": "string"
      }
    ]
}

Collections In Common Trends

Returns collections in common trends by owners of a given collection. The method returns top 30 collections with increase/decrease in the number of owners, sorted by number of common owners. Excludes tokens flagged as spam for owning wallets.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name).

query Parameters
duration
string

Time duration for the analysis.

  • DURATION_UNSPECIFIED: Unspecified value.
  • DURATION_1_DAY: 1 day.
  • DURATION_7_DAYS: 7 days.
  • DURATION_30_DAYS: 30 days.
  • DURATION_365_DAYS: 365 days.
Enum: "DURATION_1_DAY" "DURATION_7_DAYS" "DURATION_30_DAYS" "DURATION_365_DAYS"
Responses
200

A successful response.

get/audiences/v1beta1/common/collections/{contractAddress}/trends
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/audiences/v1beta1/common/collections/:contractAddress/trends?duration=DURATION_1_DAY' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "name": "string",
      • "ownersCountChange": "string",
      • "commonOwnersCount": "string"
      }
    ]
}

Financial Profiles by Collection Owners

Returns financial profiles for owners of a requested collection. Stats exclude tokens flagged as spam for owning wallets.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Collection address

query Parameters
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

Responses
200

A successful response.

get/audiences/v1beta1/financial_profiles/by_collection/{contractAddress}
Request samples
curl -i -X GET \
  'https://ethereum-rest.api.mnemonichq.com/audiences/v1beta1/financial_profiles/by_collection/:contractAddress?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "profiles": [
    • {
      • "walletAddress": "string",
      • "collectionsOwnedCount": "string",
      • "nftsOwnedCount": "string",
      • "nftsOwnedCountErc721": "string",
      • "nftsOwnedCountErc1155": "string",
      • "nftsOwnedCountEver": "string",
      • "nftsOwnedQuantity": "string",
      • "nftsRecvFirstTs": "2019-08-24T14:15:22Z",
      • "nftsRecvLastTs": "2019-08-24T14:15:22Z",
      • "nftsPurchasedFirstTs": "2019-08-24T14:15:22Z",
      • "nftsPurchasedLastTs": "2019-08-24T14:15:22Z",
      • "nftsFifoHoldingSpanAvg": "string",
      • "nftsFifoHoldingSpanMax": "string",
      • "nftsLongestHoldingSince": "2019-08-24T14:15:22Z",
      • "nftsPurchasesCount": "string",
      • "nftsPurchasesVolume": "string",
      • "nftsPurchasesAvgPrice": "string",
      • "nftsPurchasesMaxPrice": "string",
      • "nftsSalesCount": "string",
      • "nftsSalesVolume": "string",
      • "nftsTotalNetProfit": "string"
      }
    ]
}

Financial Profiles by Wallets

Returns financial profiles for requested wallets. Stats exclude tokens flagged as spam for owning wallets.

Request
Security:
ApiKeyAuth
Request Body schema: application/json
walletAddresses
required
Array of strings

List of contract addresses (or ENS names), up to 500 items.

Responses
200

A successful response.

post/audiences/v1beta1/financial_profiles/by_wallets
Request samples
application/json
{
  • "walletAddresses": [
    • "string"
    ]
}
Response samples
application/json
{
  • "profiles": [
    • {
      • "walletAddress": "string",
      • "collectionsOwnedCount": "string",
      • "nftsOwnedCount": "string",
      • "nftsOwnedCountErc721": "string",
      • "nftsOwnedCountErc1155": "string",
      • "nftsOwnedCountEver": "string",
      • "nftsOwnedQuantity": "string",
      • "nftsRecvFirstTs": "2019-08-24T14:15:22Z",
      • "nftsRecvLastTs": "2019-08-24T14:15:22Z",
      • "nftsPurchasedFirstTs": "2019-08-24T14:15:22Z",
      • "nftsPurchasedLastTs": "2019-08-24T14:15:22Z",
      • "nftsFifoHoldingSpanAvg": "string",
      • "nftsFifoHoldingSpanMax": "string",
      • "nftsLongestHoldingSince": "2019-08-24T14:15:22Z",
      • "nftsPurchasesCount": "string",
      • "nftsPurchasesVolume": "string",
      • "nftsPurchasesAvgPrice": "string",
      • "nftsPurchasesMaxPrice": "string",
      • "nftsSalesCount": "string",
      • "nftsSalesVolume": "string",
      • "nftsTotalNetProfit": "string"
      }
    ]
}

Financial Stats By Collection

Returns financial stats for given collection.

Request
Security:
ApiKeyAuth
path Parameters
contractAddress
required
string

Contract address (or ENS name).

Responses
200

A successful response.

get/audiences/v1beta1/financial_stats/by_collection/{contractAddress}
Request samples
curl -i -X GET \
  https://ethereum-rest.api.mnemonichq.com/audiences/v1beta1/financial_stats/by_collection/:contractAddress \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "walletsCount": "string",
  • "collectionsOwnedCountAvg": 0,
  • "nftsPurchasesCountAvg": 0,
  • "nftsPurchasesVolumeAvg": 0,
  • "nftsPurchasesPriceAvg": 0,
  • "walletAgeMin": "string",
  • "walletAgeMax": "string",
  • "nftsFifoHoldingSpanAvg": 0
}

Financial Stats By Wallets

Returns financial stats for given wallets.

Request
Security:
ApiKeyAuth
Request Body schema: application/json
walletAddresses
required
Array of strings

List of contract addresses (or ENS names), up to 500 items.

nftsPurchasesVolumeGte
string

Minimum NFTs purchases volume, given in the native blockchain token.

nftsPurchasesPriceAvgGte
string

Minimum average price paid for NFT purchase, given in the native blockchain token.

collectionsOwnedCountGte
string <int64>

Minimum count of unique collections currently owned by the wallet.

daysSinceLastPurchaseLte
string <int64>

Maximum days since last NFT was purchased.

Responses
200

A successful response.

post/audiences/v1beta1/financial_stats/by_wallets
Request samples
application/json
{
  • "walletAddresses": [
    • "string"
    ],
  • "nftsPurchasesVolumeGte": "string",
  • "nftsPurchasesPriceAvgGte": "string",
  • "collectionsOwnedCountGte": "string",
  • "daysSinceLastPurchaseLte": "string"
}
Response samples
application/json
{
  • "walletsCount": "string",
  • "collectionsOwnedCountAvg": 0,
  • "nftsPurchasesCountAvg": 0,
  • "nftsPurchasesVolumeAvg": 0,
  • "nftsPurchasesPriceAvg": 0,
  • "walletAgeMin": "string",
  • "walletAgeMax": "string",
  • "nftsFifoHoldingSpanAvg": 0
}

Segmented Audience

Returns wallets based on segmentation criteria. Sorts by Total Spend (in descending order).

Request
Security:
ApiKeyAuth
Request Body schema: application/json
limit
string <uint64>

Quantity of rows to return (default = 20, maximum = 500).

offset
string <uint64>

Offset to start return from (for pagination, default = 0).

required
Array of objects (GetSegmentedAudienceRequest.Collection)

Array of collection objects. Maximum number of input collections is: 2.

collectionsCondition
string (schemas)

Filter type of the collection criteria.

Enum: "CONDITION_ALL" "CONDITION_ANY"
nftsPurchasesVolumeGte
string

Minimum NFTs purchases volume, given in the native blockchain token.

nftsPurchasesPriceAvgGte
string

Minimum average price paid for NFT purchase, given in the native blockchain token.

collectionsOwnedCountGte
string <int64>

Minimum count of unique collections currently owned by the wallet.

daysSinceLastPurchaseLte
string <int64>

Maximum days since last NFT was purchased.

Responses
200

A successful response.

post/audiences/v1beta1/segmented_audience
Request samples
application/json
{
  • "limit": "string",
  • "offset": "string",
  • "collections": [
    • {
      • "contractAddress": "string",
      • "nftsOwnedCountGte": "string"
      }
    ],
  • "collectionsCondition": "CONDITION_ALL",
  • "nftsPurchasesVolumeGte": "string",
  • "nftsPurchasesPriceAvgGte": "string",
  • "collectionsOwnedCountGte": "string",
  • "daysSinceLastPurchaseLte": "string"
}
Response samples
application/json
{
  • "wallets": [
    • {
      • "walletAddress": "string",
      • "totalSpend": "string"
      }
    ]
}