> For the complete documentation index, see [llms.txt](https://metapath.gitbook.io/metapath-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://metapath.gitbook.io/metapath-api/aggregate-nfts-api-v1.0/get-nft-list.md).

# Get NFT List

Obtain the corresponding NFT list through the keyId returned by the Get Basic Information Interface and the specified filter parameters

#### Request Url: /api/v1/meta/getLists

#### Request Method: GET

#### Request Parameter:

<table><thead><tr><th width="187">Field Name</th><th>Field Description</th><th>Type</th><th>Required or not</th><th>Notes</th></tr></thead><tbody><tr><td>type</td><td>Type：collection、platform</td><td>string</td><td>Y</td><td></td></tr><tr><td>keyId</td><td>Primary Key id</td><td>integer</td><td>Y</td><td>Referring to Basic Info Return platform or Classification ID</td></tr><tr><td>priceOrder</td><td>Price sort: asc Ascending, desc Descending</td><td>string</td><td>Y</td><td></td></tr><tr><td>buyNow</td><td>Buy Now: 1 Yes, 0 No</td><td>integer</td><td>Y</td><td></td></tr><tr><td>page</td><td>Page</td><td>integer</td><td>Y</td><td></td></tr><tr><td>pageSize</td><td>Number in page</td><td>integer</td><td>Y</td><td></td></tr></tbody></table>

#### Output Parameter:&#x20;

| Field Name       | Field Description                                   | Type    |
| ---------------- | --------------------------------------------------- | ------- |
| id               | NFT Primary Key id                                  | integer |
| name             | NFT name                                            | string  |
| platformId       | Platform Primary Key id                             | integer |
| contractAddress  | NFT contract address                                | string  |
| tokenId          | tokenId                                             | string  |
| currentPrice     | Price                                               | string  |
| paymentContract  | Payment contract address                            | string  |
| paymentDecimals  | Payment token decimal                               | integer |
| paymentUrl       | Payment token logo address                          | string  |
| ownerAddress     | Current owner address                               | string  |
| imageUrl         | NFT image address                                   | string  |
| mainnet          | NFT chain                                           | string  |
| paymentTokenName | Payment token name                                  | string  |
| isSupportAny     | Whether it supports any token to NFT: 1: Yes, 0: No | integer |

#### Input Example:

<https://api.paths.finance/api/v1/meta/getLists?type=collection&keyId=386412091616028672&priceOrder=asc&buyNow=1&page=1&pageSize=50>

#### Output Example:

```
{
    "resCode": "100",
    "resMsg": "Success",
    "data": {
        "lists": [
            {
                "id": "391069956913074176",
                "name": "BoredApeYachtClub#2073",
                "platformId": "386405378620468200",
                "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
                "tokenId": "2073",
                "currentPrice": "1000069000000.000000000000000",
                "paymentContract": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                "paymentDecimals": 6,
                "paymentUrl": "https://storage.opensea.io/files/749015f009a66abcb3bbb3502ae2f1ce.svg",
                "ownerAddress": "0xb53349160e38739b37e4bbfcf950ed26e26fcb41",
                "imageUrl": "https://lh3.googleusercontent.com/gb_5zVcmUjLmU14vi9fIN3vAxmHD0x4hqEWpULXxULA8-y3E4bJTD9llj6DtAkno-YULH_FR2hU5PVRJ9DmFwh7eGL-8LgF7fnRVWxc",
                "mainnet": "ETH",
                "paymentTokenName": "USDC",
                "isSupportAny": 1
            },
            {
                "id": "406708667545485312",
                "name": "BoredApeYachtClub#4227",
                "platformId": "386405378620468200",
                "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
                "tokenId": "4227",
                "currentPrice": "85000000000000000000.00000000",
                "paymentContract": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
                "paymentDecimals": 18,
                "paymentUrl": "https://storage.opensea.io/files/6f8e2979d428180222796ff4a33ab929.svg",
                "ownerAddress": "0xcff3bc0454f3e154b5ad9737406338ab9bf47311",
                "imageUrl": "https://lh3.googleusercontent.com/hxkShKjlORLrbV7G9zLioJZjuMMG8WKUIg9p0Z7N_O2QOsxcxHOxQOrnQyXIMPibsMY4P8-G7LRjxwFbcwpfCfz9lR69ERFRLUYKaz0",
                "mainnet": "ETH",
                "paymentTokenName": "ETH",
                "isSupportAny": 1
            },
            {
                "id": "406705636922595328",
                "name": "BoredApeYachtClub#8855",
                "platformId": "386405378620468200",
                "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
                "tokenId": "8855",
                "currentPrice": "85000000000000000000.00000000",
                "paymentContract": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
                "paymentDecimals": 18,
                "paymentUrl": "https://storage.opensea.io/files/6f8e2979d428180222796ff4a33ab929.svg",
                "ownerAddress": "0xdbc5be1935a26335c19d337dccdaa3e003f7438f",
                "imageUrl": "https://lh3.googleusercontent.com/i0qDxQeyEH8DRrHyc9hrds7-6YlCUrHqSKvXnZARlwSrchnGkp_B5X_4GyocBDUt0-GIptCMPvmGrgs_Ffi1bJRbbmYPfhlffCWq3g",
                "mainnet": "ETH",
                "paymentTokenName": "ETH",
                "isSupportAny": 1
            }
        ],
        "total": 544
    }
}
```

#### Postman Call Example

![](https://2618925675-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvKZb9H0fI8f0PVUwaWn5%2Fuploads%2F9B1lTxCvzlvI8L0MdcBZ%2Fimage.png?alt=media\&token=de344dd6-e55c-4341-992c-3e698524c715)