ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 11:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Address comments, fix source links

Browse Source
This commit is contained in:
ddawson
2024-03-18 09:52:28 -07:00
parent 1ece0dddbb
commit 612e313d04
2 changed files with 33 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md
View File

@@ -8,7 +8,7 @@ labels:
---
# nft_history
[[Source]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTHistory.cpp "Source")
[[Source]](https://github.com/XRPLF/clio/blob/develop/src/rpc/handlers/NFTHistory.cpp "Source")
The `nft_history` command asks the Clio server for past transaction metadata for the [NFT](../../../../concepts/tokens/nfts/index.md) being queried. {% badge href="https://github.com/XRPLF/clio/releases/tag/1.1.0" %}New in: Clio v1.1.0{% /badge %}

42
docs/references/http-websocket-apis/public-api-methods/clio-methods/nfts_by_issuer.md
View File

@@ -8,7 +8,7 @@ labels:
---
# nfts_by_issuer
[[Source]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTHistory.cpp "Source")
[[Source]](https://github.com/XRPLF/clio/blob/develop/src/rpc/handlers/NFTsByIssuer.cpp "Source")
`nfts_by_issuer` returns a list of NFTokens that are issued by the specified account. It can optionally filter by taxon. {% badge href="https://github.com/XRPLF/clio/releases/tag/1.1.0" %}New in: Clio v2.1.0{% /badge %}
@@ -30,7 +30,7 @@ The request contains the following parameters:
| `Field` | Type | Description |
|:---------------|:--------|:-------------------------------|
| `issuer` | String | A unique identifier for the account, most commonly the account's address. |
| `marker` | Marker | Value from a previous paginated response. Resume retrieving data where that response left off. This value is NOT stable if there is a change in the server's range of available ledgers; meaning if you are querying the “validated” ledger it is possible that new NFTs are created during your paging. |
| `marker` | Marker | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. This value is NOT stable if there is a change in the server's range of available ledgers; meaning if you are querying the “validated” ledger it is possible that new NFTs are created during your paging. |
| `nft_taxon` | Integer | _(Optional)_ Use to filter NFTs issued by this issuer that have this taxon. |
| `ledger_hash` | String | _(Optional)_ Use to look for NFTs issued up to the provided ledger. If not provided, the server uses the current ledger. |
| `ledger_index` | String or Integer | _(Optional)_ Use to look for NFTs issued up to the provided ledger. If not provided, the server uses the current ledger. |
@@ -44,13 +44,34 @@ The request contains the following parameters:
An example of a successful response:
```json
{"result":{
"nft_id":"00082710D16560292CA49840AE2DDD7A2CAA50C386BC1B6704F1BB1A004D027F","ledger_index":5046924,"owner":"rLaBCoaMQqXzHDmiGs2Qv2JA2bg3Yvzxyt",
"is_burned":false,
"flags":8,
"transfer_fee":10000,
"issuer":"rLaBCoaMQqXzHDmiGs2Qv2JA2bg3Yvzxyt",
"nft_taxon":0,"nft_serial":5046911,"validated":true,"uri":"697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469"},"id":1,"status":"success","type":"response","warnings":[{"id":2001,"message":"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"}]
{
"result": {
"issuer": "rfXeQv31yWMrhhPxMHZRzQqhw5mQrcuici",
"limit": 50,
"ledger_index": 1534,
"nfts": [
{
"nft_id": "00080000479C76BC5174816A938ABF667E67D851140BFE03F068FA97000005FB",
"ledger_index": 1533,
"owner": "rfXeQv31yWMrhhPxMHZRzQqhw5mQrcuici",
"is_burned": false,
"uri": "",
"flags": 8,
"transfer_fee": 0,
"issuer": "rfXeQv31yWMrhhPxMHZRzQqhw5mQrcuici",
"nft_taxon": 1,
"nft_serial": 1531
}
],
"validated": true,
"status": "success"
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
@@ -62,8 +83,9 @@ The response follows the [standard format][], with a successful result containin
| `nfts` | Array<Object> | A list of NFTs issued by the account. The order of the NFTs is not associated with the date the NFTs were minted. |
| `marker` | Marker | _(Optional)_ Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. If this field is not returned, you know that you no longer need to make calls to this API. |
| `limit` | Integer | The `limit`, as specified in the request. |
| `nft_taxon` | Integer | The `nft_taxon` as specified in the request. |
| `nft_taxon` | Integer | _(Optional)_ The `nft_taxon` as specified in the request. |
The format of each NFT in the `nfts` array is the same as the response to an [`nft_info`](nft_info.md) request.
For definitions of the fields returned in the `tx` object, see [Transaction Metadata](../../../protocol/transactions/metadata.md).