Authentication

ApiKeyAuth

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

Collections

CollectionsService provides the ability to get collection and owners statistics.

List of current owners by contract

Get the list of current owner addresses by contract address.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFTs.

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).

Enum: "SORT_DIRECTION_ASC" "SORT_DIRECTION_DESC"
Responses
200

A successful response.

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

Owners count by contract

Get owners count by contract address.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFTs.

query Parameters
duration
required
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"
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.

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.

  • GROUP_BY_PERIOD_UNSPECIFIED: Undefined value.

  • GROUP_BY_PERIOD_15_MINUTES: 15 minutes.

  • GROUP_BY_PERIOD_1_HOUR: 1 hour.

  • GROUP_BY_PERIOD_1_DAY: 1 day.

Enum: "GROUP_BY_PERIOD_15_MINUTES" "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
Responses
200

A successful response.

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

Tokens supply by contract

Get tokens supply summary by a contract address.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFTs.

query Parameters
duration
required
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"
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.

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.

  • GROUP_BY_PERIOD_UNSPECIFIED: Undefined value.

  • GROUP_BY_PERIOD_15_MINUTES: 15 minutes.

  • GROUP_BY_PERIOD_1_HOUR: 1 hour.

  • GROUP_BY_PERIOD_1_DAY: 1 day.

Enum: "GROUP_BY_PERIOD_15_MINUTES" "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
Responses
200

A successful response.

get/polygon/collections/v1beta1/supply/{contractAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/collections/v1beta1/supply/:contractAddress?duration=DURATION_1_DAY&timestampLt=2019-08-24T14%3A15%3A22Z&groupByPeriod=GROUP_BY_PERIOD_15_MINUTES' \
  -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"
      }
    ]
}

Top collections by avg price

Get top collections by average price.

Request
Security:
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).

duration
required
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/polygon/collections/v1beta1/top/by_avg_price
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/collections/v1beta1/top/by_avg_price?limit=string&offset=string&duration=DURATION_1_DAY' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "avgPrice": "string",
      • "contractName": "string"
      }
    ]
}

Top collections by max price

Get top collections by maximum price.

Request
Security:
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).

duration
required
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/polygon/collections/v1beta1/top/by_max_price
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/collections/v1beta1/top/by_max_price?limit=string&offset=string&duration=DURATION_1_DAY' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "maxPrice": "string",
      • "contractName": "string"
      }
    ]
}

Top collections by sales count

Get top collections by sales count.

Request
Security:
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).

duration
required
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/polygon/collections/v1beta1/top/by_sales_count
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/collections/v1beta1/top/by_sales_count?limit=string&offset=string&duration=DURATION_1_DAY' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "salesCount": "string",
      • "contractName": "string"
      }
    ]
}

Top collections by sales volume

Get top collections by sales volume.

Request
Security:
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).

duration
required
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/polygon/collections/v1beta1/top/by_sales_volume
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/collections/v1beta1/top/by_sales_volume?limit=string&offset=string&duration=DURATION_1_DAY' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "collections": [
    • {
      • "contractAddress": "string",
      • "salesVolume": "string",
      • "contractName": "string"
      }
    ]
}

Traits Summary

Get aggregated traits information for a collection.

Request
Security:
path Parameters
contractAddress
required
string

Contract address of the collection.

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/polygon/collections/v1beta1/traits/{contractAddress}/summary
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/collections/v1beta1/traits/:contractAddress/summary?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "traitSummaries": [
    • {
      • "name": "string",
      • "displayType": "DISPLAY_TYPE_PROPERTY",
      • "valueType": "VALUE_TYPE_NUMERIC",
      • "valueNumeric": {
        • "min": 0,
        • "max": 0
        },
      • "valueString": {
        • "value": "string",
        • "tokenCount": "string",
        • "traitPercentage": 0
        },
      • "valueDate": {
        • "min": "2019-08-24T14:15:22Z",
        • "max": "2019-08-24T14:15:22Z"
        }
      }
    ]
}

Contracts

ContractsService provides the ability to get details about smart contracts.

All Contracts

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

Request
Security:
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).

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.

  • TOKEN_TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TOKEN_TYPE_UNKNOWN: Unknown represents undetected contract type.
  • TOKEN_TYPE_ERC20: ERC20 type (fungible tokens).
  • TOKEN_TYPE_ERC721: ERC721 type.
  • TOKEN_TYPE_ERC1155: ERC1155 type.
Items Enum: "TOKEN_TYPE_UNKNOWN" "TOKEN_TYPE_ERC20" "TOKEN_TYPE_ERC721" "TOKEN_TYPE_ERC1155"
Responses
200

A successful response.

get/polygon/contracts/v1beta1/all
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/contracts/v1beta1/all?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&blockTimestampGt=2019-08-24T14%3A15%3A22Z&contractTypes=TOKEN_TYPE_UNKNOWN' \
  -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": [
        • "TOKEN_TYPE_UNKNOWN"
        ]
      }
    ]
}

Contract Details

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

Request
Security:
path Parameters
contractAddress
required
string

Contract address.

Responses
200

A successful response.

get/polygon/contracts/v1beta1/by_address/{contractAddress}
Request samples
curl -i -X GET \
  https://polygon.rest.mnemonichq.com/polygon/contracts/v1beta1/by_address/:contractAddress \
  -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": [
      • "TOKEN_TYPE_UNKNOWN"
      ]
    }
}

NFT Contract Metadata

Returns collection level information (counts, total volumes), and collection metadata from on-chain and off-chain sources.

Request
Security:
path Parameters
contractAddress
required
string

Contract address.

Responses
200

A successful response.

get/polygon/contracts/v1beta1/nft/metadata/{contractAddress}
Request samples
curl -i -X GET \
  https://polygon.rest.mnemonichq.com/polygon/contracts/v1beta1/nft/metadata/:contractAddress \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "types": [
    • "TOKEN_TYPE_UNKNOWN"
    ],
  • "name": "string",
  • "tokensCount": "string",
  • "ownersCount": "string",
  • "salesVolume": "string",
  • "metadata": [
    • {
      • "type": "TYPE_BANNER_IMAGE_URL",
      • "value": "string"
      }
    ]
}

Pricing

PricingService provides the ability to get realtime pricing and trading information for the collection.

Prices by contract

Get prices history by contract address.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFTs.

query Parameters
duration
required
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"
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.

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.

  • GROUP_BY_PERIOD_UNSPECIFIED: Undefined value.

  • GROUP_BY_PERIOD_15_MINUTES: 15 minutes.

  • GROUP_BY_PERIOD_1_HOUR: 1 hour.

  • GROUP_BY_PERIOD_1_DAY: 1 day.

Enum: "GROUP_BY_PERIOD_15_MINUTES" "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
Responses
200

A successful response.

get/polygon/pricing/v1beta1/prices/by_contract/{contractAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/pricing/v1beta1/prices/by_contract/:contractAddress?duration=DURATION_1_DAY&timestampLt=2019-08-24T14%3A15%3A22Z&groupByPeriod=GROUP_BY_PERIOD_15_MINUTES' \
  -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 by contract

Get sales volume and count by contract address.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFTs.

query Parameters
duration
required
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"
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.

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.

  • GROUP_BY_PERIOD_UNSPECIFIED: Undefined value.

  • GROUP_BY_PERIOD_15_MINUTES: 15 minutes.

  • GROUP_BY_PERIOD_1_HOUR: 1 hour.

  • GROUP_BY_PERIOD_1_DAY: 1 day.

Enum: "GROUP_BY_PERIOD_15_MINUTES" "GROUP_BY_PERIOD_1_HOUR" "GROUP_BY_PERIOD_1_DAY"
Responses
200

A successful response.

get/polygon/pricing/v1beta1/volumes/by_contract/{contractAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/pricing/v1beta1/volumes/by_contract/:contractAddress?duration=DURATION_1_DAY&timestampLt=2019-08-24T14%3A15%3A22Z&groupByPeriod=GROUP_BY_PERIOD_15_MINUTES' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "dataPoints": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "count": "string",
      • "volume": "string"
      }
    ]
}

Tokens

TokensService provides the ability to get the NFTs that match various criteria and details about specific NFTs.

NFTs by the Contract

Get the list of NFTs tracked by a given contract.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks the NFT.

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).

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/polygon/tokens/v1beta1/by_contract/{contractAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/tokens/v1beta1/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
{
  • "tokens": [
    • {
      • "contractAddress": "string",
      • "tokenId": "string",
      • "type": "TOKEN_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"
        }
      }
    ]
}

NFTs by the Minter

Get the list of NFTs minted by a given address.

Request
Security:
path Parameters
minterAddress
required
string

Filter by minter 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).

contractAddress
string

Filter by contract address.

tokenTypes
Array of strings

Filter by the token types.

  • TOKEN_TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TOKEN_TYPE_ERC721: ERC721 type.
  • TOKEN_TYPE_ERC1155: ERC1155 type.
Items Enum: "TOKEN_TYPE_ERC721" "TOKEN_TYPE_ERC1155"
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/polygon/tokens/v1beta1/by_minter/{minterAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/tokens/v1beta1/by_minter/:minterAddress?limit=string&offset=string&contractAddress=string&tokenTypes=TOKEN_TYPE_ERC721&blockTimestampGt=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "tokens": [
    • {
      • "contractAddress": "string",
      • "tokenId": "string",
      • "type": "TOKEN_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"
        }
      }
    ]
}

NFTs by the Owner

Get the list of NFTs owned by a given address.

Request
Security:
path Parameters
ownerAddress
required
string

Filter by owner 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).

contractAddress
string

Filter by contract address.

tokenTypes
Array of strings

Filter by the token types.

  • TOKEN_TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TOKEN_TYPE_ERC721: ERC721 type.
  • TOKEN_TYPE_ERC1155: ERC1155 type.
Items Enum: "TOKEN_TYPE_ERC721" "TOKEN_TYPE_ERC1155"
Responses
200

A successful response.

get/polygon/tokens/v1beta1/by_owner/{ownerAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/tokens/v1beta1/by_owner/:ownerAddress?limit=string&offset=string&contractAddress=string&tokenTypes=TOKEN_TYPE_ERC721' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "tokens": [
    • {
      • "contractAddress": "string",
      • "tokenId": "string",
      • "type": "TOKEN_TYPE_ERC721",
      • "metadata": {
        • "metadataUri": {
          • "uri": "string",
          • "mimeType": "string"
          },
        • "name": "string",
        • "description": "string",
        • "image": {
          • "uri": "string",
          • "uriOriginal": "string",
          • "mimeType": "string"
          }
        },
      • "quantity": "string"
      }
    ]
}

Token Metadata

Get full metadata of a given NFT.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFT.

tokenId
required
string

Token ID.

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/polygon/tokens/v1beta1/token/{contractAddress}/{tokenId}/metadata
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/tokens/v1beta1/token/:contractAddress/:tokenId/metadata?limit=string&offset=string' \
  -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"
    }
}

NFT Owners

Get the list of NFT owners including the quantity owned.

Request
Security:
path Parameters
contractAddress
required
string

Contract address 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/polygon/tokens/v1beta1/token/{contractAddress}/{tokenId}/owners
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/tokens/v1beta1/token/:contractAddress/:tokenId/owners?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "owners": [
    • {
      • "address": "string",
      • "quantity": "string"
      }
    ]
}

Token Traits

Get all token traits of a given NFT.

Request
Security:
path Parameters
contractAddress
required
string

Contract address that tracks NFT.

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/polygon/tokens/v1beta1/token/{contractAddress}/{tokenId}/traits
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/tokens/v1beta1/token/: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",
        • "tokenCount": "string",
        • "traitPercentage": 0
        },
      • "valueDate": {
        • "value": "2019-08-24T14:15:22Z",
        • "min": "2019-08-24T14:15:22Z",
        • "max": "2019-08-24T14:15:22Z"
        }
      }
    ]
}

Transfers Insights

Transfers Insights endpoints allows to get transfer events by various criteria. The service provides NFT transfers with price attribution per token transfered, which is especially important in multi-token transactions. In addition the service also provides full transfers breakout by transactions.

Transfers by Tx Hash

Get list of NFT, MATIC and ERC20 transfers by the transaction hash (for NFT-related transactions only).

Request
Security:
path Parameters
txHash
required
string

Transaction hash.

Responses
200

A successful response.

get/polygon/transfers/v1beta1/all/by_tx_hash/{txHash}
Request samples
curl -i -X GET \
  https://polygon.rest.mnemonichq.com/polygon/transfers/v1beta1/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": "TOKEN_TYPE_ERC721",
      • "transferType": "TRANSFER_TYPE_MINT",
      • "quantity": "string",
      • "sender": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "senderReceived": {
        • "totalMatic": "string",
        • "totalUsd": "string",
        • "maticTransfersTotal": "string",
        • "erc20TransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "erc20Totals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "recipient": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "recipientPaid": {
        • "totalMatic": "string",
        • "totalUsd": "string",
        • "maticTransfersTotal": "string",
        • "erc20TransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "erc20Totals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "labels": [
        • "LABEL_MINT"
        ]
      }
    ],
  • "maticTransfers": [
    • {
      • "fromAddress": "string",
      • "toAddress": "string",
      • "valueRaw": "string",
      • "valueNormalized": "string"
      }
    ],
  • "erc20Transfers": [
    • {
      • "fromAddress": "string",
      • "toAddress": "string",
      • "contractAddress": "string",
      • "valueRaw": "string",
      • "valueNormalized": "string",
      • "valueMatic": "string"
      }
    ]
}

NFT Transfers

Get list of the NFT transfers by various criteria.

Request
Security:
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).

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.

contractAddress
string

Filter by NFT contract address.

tokenId
string

Filter by NFT Token ID.

transferTypes
Array of strings

DEPRECATED. Filter by transfer types (any of).

  • TRANSFER_TYPE_UNSPECIFIED: Undefined (should not be present in real data).
  • TRANSFER_TYPE_MINT: Mint.

Transfer is considered to be a mint, when sender address is 0x0000000000000000000000000000000000000000.

  • TRANSFER_TYPE_BURN: Burn.

Transfer is considered to be a burn, when recepient is 0x0000000000000000000000000000000000000000 or 0x000000000000000000000000000000000000dead.

  • TRANSFER_TYPE_REGULAR: Regular transfer.

Transfer is considered to be regular, when it is neither a burn nor mint. Another special case is when it is mint and burn at the same time.

Items Enum: "TRANSFER_TYPE_MINT" "TRANSFER_TYPE_BURN" "TRANSFER_TYPE_REGULAR"
tokenTypes
Array of strings

Filter by token types (any of).

  • TOKEN_TYPE_UNSPECIFIED: Unset is a system value (shouldn't be used in real data).
  • TOKEN_TYPE_ERC721: ERC721 type.
  • TOKEN_TYPE_ERC1155: ERC1155 type.
Items Enum: "TOKEN_TYPE_ERC721" "TOKEN_TYPE_ERC1155"
senderAddress
string

Filter by sender address.

recipientAddress
string

Filter by recipient address.

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 MATIC or ERC-20 transfers inside the same transaction. Also, total value of all incoming and outgoing seller MATIC and ERC-20 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;
  • LABEL_MARKETPLACE_OPENSEA: Labels that include "MARKETPLACE", indicates the specific marketplace where a transaction occurred.
Items Enum: "LABEL_MINT" "LABEL_BURN" "LABEL_SALE" "LABEL_TRANSFER" "LABEL_SWAP" "LABEL_BUNDLE" "LABEL_MARKETPLACE_OPENSEA"
Responses
200

A successful response.

get/polygon/transfers/v1beta1/nft
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/transfers/v1beta1/nft?limit=string&offset=string&sortDirection=SORT_DIRECTION_ASC&blockTimestampGt=2019-08-24T14%3A15%3A22Z&contractAddress=string&tokenId=string&transferTypes=TRANSFER_TYPE_MINT&tokenTypes=TOKEN_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": "TOKEN_TYPE_ERC721",
      • "transferType": "TRANSFER_TYPE_MINT",
      • "quantity": "string",
      • "sender": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "senderReceived": {
        • "totalMatic": "string",
        • "totalUsd": "string",
        • "maticTransfersTotal": "string",
        • "erc20TransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "erc20Totals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "recipient": {
        • "address": "string",
        • "type": "TYPE_OWNER"
        },
      • "recipientPaid": {
        • "totalMatic": "string",
        • "totalUsd": "string",
        • "maticTransfersTotal": "string",
        • "erc20TransfersTotal": "string",
        • "attributedBy": "ATTRIBUTED_BY_ZERO_QUANTITY_TX",
        • "erc20Totals": [
          • {
            • "contractAddress": "string",
            • "totalNormalized": "string"
            }
          ]
        },
      • "labels": [
        • "LABEL_MINT"
        ]
      }
    ]
}

Blockchain

BlockchainService provides the ability to query basic primitives of the polygon blockchain (such as blocks, transactions, logs, etc).

Block by Number

Returns the block corresponding to a given block number.

Request
Security:
path Parameters
blockNumber
required
string

A block number.

Responses
200

A successful response.

get/polygon/blockchain/v1beta1/blocks/by_number/{blockNumber}
Request samples
curl -i -X GET \
  https://polygon.rest.mnemonichq.com/polygon/blockchain/v1beta1/blocks/by_number/:blockNumber \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "block": {
    • "number": "string",
    • "hash": "string",
    • "parentHash": "string",
    • "timestamp": "2019-08-24T14:15:22Z",
    • "size": "string",
    • "gasUsed": "string",
    • "gasLimit": "string",
    • "baseFeePerGas": "string",
    • "miner": "string",
    • "nonce": "string"
    }
}

Logs by Tx Hash

Returns in a paginated manner the list of logs corresponding to a given transaction hash.

Request
Security:
path Parameters
transactionHash
required
string

A transaction hash.

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/polygon/blockchain/v1beta1/logs/by_transaction_hash/{transactionHash}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/blockchain/v1beta1/logs/by_transaction_hash/:transactionHash?limit=string&offset=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "logs": [
    • {
      • "transactionHash": "string",
      • "index": "string",
      • "address": "string",
      • "removed": true,
      • "topic0": "string",
      • "topic1": "string",
      • "topic2": "string",
      • "topic3": "string",
      • "data": "string",
      • "timestamp": "2019-08-24T14:15:22Z"
      }
    ]
}

Transaction Receipt

Returns the receipt corresponding to the transaction with a given hash.

Request
Security:
path Parameters
transactionHash
required
string

A transaction hash.

Responses
200

A successful response.

get/polygon/blockchain/v1beta1/transaction_receipts/by_hash/{transactionHash}
Request samples
curl -i -X GET \
  https://polygon.rest.mnemonichq.com/polygon/blockchain/v1beta1/transaction_receipts/by_hash/:transactionHash \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "transactionReceipt": {
    • "transactionHash": "string",
    • "status": "string",
    • "postState": "string",
    • "gasUsed": "string",
    • "cumulativeGasUsed": "string",
    • "contractAddress": "string",
    • "transactionIndex": 0
    }
}

Transaction by Hash

Returns the transaction corresponding to a given hash.

Request
Security:
path Parameters
transactionHash
required
string

A transaction hash.

Responses
200

A successful response.

get/polygon/blockchain/v1beta1/transactions/by_hash/{transactionHash}
Request samples
curl -i -X GET \
  https://polygon.rest.mnemonichq.com/polygon/blockchain/v1beta1/transactions/by_hash/:transactionHash \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "transaction": {
    • "hash": "string",
    • "blockNumber": "string",
    • "fromAddress": "string",
    • "toAddress": "string",
    • "value": "string",
    • "data": "string",
    • "type": 0,
    • "nonce": "string",
    • "gasLimit": "string",
    • "gasPrice": "string",
    • "gasFeeCap": "string",
    • "gasTipCap": "string"
    }
}

Wallet Intelligence

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

NFTs by Wallet

Get list of the NFTs owned by the specified wallet.

Request
Security:
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_UNSPECIFIED: Return all tokens (default).
  • SPAM_EXCLUDE: Exclude spam.
  • SPAM_ONLY: Return only spam.
Enum: "SPAM_EXCLUDE" "SPAM_ONLY"
Responses
200

A successful response.

get/polygon/wallets/v1beta1/{walletAddress}/nfts
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/wallets/v1beta1/:walletAddress/nfts?limit=string&offset=string&contractAddress=string&spam=SPAM_EXCLUDE' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "tokens": [
    • {
      • "contractAddress": "string",
      • "tokenId": "string",
      • "metadata": {
        • "metadataUri": {
          • "uri": "string",
          • "mimeType": "string"
          },
        • "name": "string",
        • "description": "string",
        • "image": {
          • "uri": "string",
          • "uriOriginal": "string",
          • "mimeType": "string"
          }
        },
      • "quantity": "string",
      • "spam": true
      }
    ]
}

Report Not Spam

Report that a collection or token was inaccurately flagged as spam.

Request
Security:
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/polygon/wallets/v1beta1/{walletAddress}/report_not_spam/{contractAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/wallets/v1beta1/: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 token as spam.

Request
Security:
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/polygon/wallets/v1beta1/{walletAddress}/report_spam/{contractAddress}
Request samples
curl -i -X GET \
  'https://polygon.rest.mnemonichq.com/polygon/wallets/v1beta1/:walletAddress/report_spam/:contractAddress?tokenId=string&feedback=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'
Response samples
application/json
{ }