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

# NFT List

## <mark style="color:blue;">GET</mark> /api/v1/nft/list

* Through this API, you will be able to query the NFT list held by the user
* Header

| Field  | Type   | Required | Remarks                                                                   |
| ------ | ------ | -------- | ------------------------------------------------------------------------- |
| ApiKey | String | true     | [ApiKey](/relation-graph/api/nft-list.md) obtained from the administrator |

* Request Parameters

| Field           | Type   | Required | Remarks          |
| --------------- | ------ | -------- | ---------------- |
| address         | String | fasle    | EOA Address      |
| twitterUsername | String | fasle    | twitter username |
| steamId         | String | fasle    | steamId          |

* Request Example

```shell
curl  GET 'https://api.relationlabs.ai/api/v1/nft/list?address=0x9bd286ef4e3d9ec1af6c6ae9da2f0b3617deab13' \
--header 'ApiKey: <ApiKey>'
```

* Response Parameters

| Field | Type   | Remarks         |
| ----- | ------ | --------------- |
| code  | String | Return code     |
| desc  | String | Return message  |
| data  | List   | User's NFT list |

The NFT field consists of the following subfields:

| Field           | Type   | Remarks              |
| --------------- | ------ | -------------------- |
| contractAddress | String | NFT contract address |
| name            | String | NFT Name             |
| tokenId         | String | tokenId              |
| imageUrl        | String | image url            |
| metadataUrl     | String | metadata url         |

* Response Body

```json
{
  "code": "0",
  "desc": "success",
  "data": [
    {
      "contractAddress": "0x1dcc0fbb80d2c6a62ee35835e03c98924d413153",
      "name": "Relation Medal Not Alone",
      "tokenId": "32945",
      "imageUrl": "https://3fypb-gqaaa-aaaag-aaedq-cai.ic1.io/icon/medal/medal_5.png",
      "metadataUrl": "https://z.com/aa.json"
    }
  ]
}
```

* Return Code

| code  | desc    | Remarks                                   |
| ----- | ------- | ----------------------------------------- |
| 0     | success | the flag for a successful request         |
| 11601 | failed  | this field not support in current version |
| 11602 | failed  | user not found                            |