mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-30 08:35:50 +00:00
Merge pull request #1862 from XRPLF/add_nft_api_topic
add nft api topic
This commit is contained in:
57
content/concepts/tokens/nft-apis.md
Normal file
57
content/concepts/tokens/nft-apis.md
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
html: nft-apis.html
|
||||
parent: non-fungible-tokens.html
|
||||
blurb: Specialized APIs let you access useful NFT metadata.
|
||||
labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
---
|
||||
# NFT APIs
|
||||
|
||||
This page lists the transactions and requests associated with NFTs as a handy reference.
|
||||
|
||||
## NFT Objects
|
||||
|
||||
- [NFToken][] data type - The NFT object stored on the ledger.
|
||||
- Ledger Objects
|
||||
- [NFTokenOffer object][] - An offer to buy or sell an NFT.
|
||||
- [NFTokenPage object][] - An NFT page holds a maximum of 32 NFT objects. In practice, each NFT page typically holds 16-24 NFTs.
|
||||
|
||||
## NFT Transactions
|
||||
|
||||
- [NFTokenMint][] - Create an NFT.
|
||||
|
||||
- [NFTokenCreateOffer][] - Create an offer to buy or sell an NFT.
|
||||
|
||||
- [NFTokenCancelOffer][] - Cancel an offer to buy or sell an NFT.
|
||||
|
||||
- [NFTokenAcceptOffer][] - Accept an offer to buy or sell an NFT.
|
||||
|
||||
- [NFTokenBurn][] - Permanently destroy an NFT.
|
||||
|
||||
## NFT requests
|
||||
|
||||
- [account_nfts method][] - Get a list of non-fungible tokens owned by an account.
|
||||
- [nft_buy_offers method][] - Get a list of buy offers for a specified NFToken object.
|
||||
- [nft_sell_offers method][] - Get a list of sell offers for a specified NFToken object.
|
||||
- [subscribe method][] - Listen for updates about a particular subject. For example, a marketplace can publish real-time updates on the status of NFTs listed on their platform.
|
||||
- [unsubscribe method][] - Stop listening for updates about an NFT.
|
||||
|
||||
## Clio
|
||||
|
||||
Clio servers enhance overall network performance by handling requests for information based on cached information, freeing up validators on the XRP Ledger to focus on processing transactions. In addition to all of the common XRP Ledger request types, the Clio server handles additional request types that provide more detailed responses.
|
||||
|
||||
### Clio-specific NFT requests
|
||||
|
||||
- [nft_info](nft_info.html) - Get current status information about the specified NFT.
|
||||
- [nft_history](nft_history.html) - Get past transaction metadata for the specified NFT.
|
||||
|
||||
<!--
|
||||
[nfts_by_issuer](nfts_by_issuer.html) - Get a list of all NFTs created by the specified issuer.
|
||||
-->
|
||||
|
||||
You can access a public Clio server by sending a request to its URL and Clio port (typically 51233). Public Clio API servers come with no SLAs nor any responsibility to be fixed on priority. If your business use case requires continual monitoring and information requests, consider setting up your own Clio server instance. See [install-clio-on-ubuntu](install-clio-on-ubuntu.html).
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
@@ -6,9 +6,9 @@ labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
---
|
||||
|
||||
# Non-Fungible Tokens Overview
|
||||
# Non-Fungible Tokens
|
||||
|
||||
The XRP Ledger supports non-fungible tokens (NFTs, or “nifties” in the vernacular) natively. Non-fungible tokens serve to encode ownership of unique physical, non-physical, or purely digital goods, such as works of art or in-game items.
|
||||
The XRP Ledger natively supports non-fungible tokens (NFTs, or “nifties” in the vernacular). Non-fungible tokens serve to encode ownership of unique physical, non-physical, or purely digital goods, such as works of art or in-game items.
|
||||
|
||||
_(Added by the [NonFungibleTokensV1_1 amendment][].)_
|
||||
|
||||
@@ -64,25 +64,6 @@ You can destroy a `NFToken` you own using the [NFTokenBurn transaction][]. If th
|
||||
|
||||
For more info about transferring `NFToken` objects, see [Trading NFTokens on the XRP Ledger](non-fungible-token-transfers.html).
|
||||
|
||||
|
||||
## Reference
|
||||
|
||||
- [NFToken][] data type
|
||||
- Ledger Objects
|
||||
- [NFTokenOffer object][]
|
||||
- [NFTokenPage object][]
|
||||
- Transactions
|
||||
- [NFTokenMint transaction][]
|
||||
- [NFTokenCreateOffer transaction][]
|
||||
- [NFTokenCancelOffer transaction][]
|
||||
- [NFTokenAcceptOffer transaction][]
|
||||
- [NFTokenBurn transaction][]
|
||||
- API Methods
|
||||
- [account_nfts method][]
|
||||
- [nft_sell_offers method][]
|
||||
- [nft_buy_offers method][]
|
||||
- [nft_info method][] (Clio server only)
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
|
||||
Reference in New Issue
Block a user