Royalties Status of NFT πŸ’° - /nft/royalty_status_nft/{nft}

πŸ” Endpoint Summary

This endpoint retrieves the royalty status for a specific NFT. It returns a dictionary with the royalty status information for the specified NFT.

πŸ“ API Path Parameters

Parameter
Type
Description

nft

str

The mint (i.e., unique identifier) of the NFT to retrieve the royalty status for.

πŸ”’ Query Parameters

Parameter
Type
Description

summarized

bool

An optional flag that, if set to true, removes transaction data to minimize the returned data size.

πŸ’Ύ Response

The response is a dictionary containing the following information:

{
    "royalty_status": {
        "nft_mint": "abcdefg",
        "total_royalties_owed": 1000,
        "transactions": [
            {
                "tx_id": "abcdefg",
                "timestamp": "2022-01-01T00:00:00Z",
                "amount": 100
            },
            ...
        ]
    }
}

πŸ”¨ Example Usage

import requests

nft = "abcdefg"
summarized = True

response = requests.get(f"https://api.example.com/nft/royalty_status_nft/{nft}?summarized={summarized}")

print(response.json())

πŸ“ˆ Possible Use Cases

  • Retrieving the current royalty status of an NFT to ensure that all owed royalties have been paid.

  • Displaying the current royalty status of an NFT on a marketplace or portfolio website.

  • Keeping track of the total amount of royalties owed for a specific NFT over time.

Last updated

Was this helpful?