RADAR Docs
  • bot_help
    • alpha
      • announce_channels
      • call
      • register
      • resend
    • analytics
      • chart
      • floor
      • info
      • terminal
    • collections
      • add
      • edit
      • manage
      • remove
    • impostor
      • register
      • unregister
      • unwhitelist
      • whitelist
    • multisig
      • add_signer
      • create
      • sign
    • profiles
      • add_availability
      • afk
      • availability
      • back
      • referral
      • register
      • remove_availability
      • set_afk_message
      • set_timezone
    • raid
      • channel
      • panel
      • register
      • resend
      • role
      • subscribe
      • tweet
    • rarity
      • check
      • rank
      • scraper
      • snipe
    • secret
      • announce_channels
      • author
      • delete
      • edit
      • note
      • resend
    • server
      • backup
      • holder_welcome
      • holder_welcome_remove
      • holder_welcome_test
      • txt2discord
      • undo
    • shop
      • add_category
      • add_product
      • buy
      • create
      • fund
      • open
      • update_product
      • update_shop
    • tools
      • snapshot
    • verification
      • add
      • blacklist
      • manual
      • panel
      • profile
      • refresh_hashlist
      • register
      • role
      • test_token
      • toggle
      • unblacklist
    • votes
      • clear
      • create
      • extend
      • max_weight
      • multipliers
      • resend
    • whalewatch
      • add
      • settings
    • whitelist
      • add_role
      • create
      • enter
      • export
      • manage
      • minimum_balance
      • panel
      • remove
      • stats
      • update
      • wipe
  • api_documentation
    • docs
      • nft
        • Get NFT 🚀 - /nft/moonrank/{mint_address}
        • Get Guild Royalty Dashboard 💸 - /nft/guild_royalty_data/{guild_id}/dashboard
        • Get Multiple NFT Metadata 🔎 - /nft/metadata/multiple/
        • Get NFT Owner Information 🔎 - /nft/{mint}/owner
        • Retrieve Holder Snapshot for NFT 📊 - /nft/holder_snapshot
        • Royalties Status by Address 💰 - /nft/royalty_status_address/{address}
        • Royalties Status of Multiple NFTs 💰 - /nft/royalty_status_multiple_nfts
        • Royalties Status of NFT 💰 - /nft/royalty_status_nft/{nft}
Powered by GitBook
On this page
  • 🔍 Endpoint Summary
  • 📝 API Path Parameters
  • 💾 Response
  • 🔨 Example Usage
  • 📈 Possible Use Cases

Was this helpful?

  1. api_documentation
  2. docs
  3. nft

Royalties Status by Address 💰 - /nft/royalty_status_address/{address}

🔍 Endpoint Summary

This endpoint retrieves the royalty status for a given address. It returns a dictionary containing the address and the royalty status for that address.

📝 API Path Parameters

Parameter
Type
Description

address

str

The address to retrieve the royalty status for.

💾 Response

The response is a dictionary containing the following information:

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

🔨 Example Usage

import requests

address = "abcdefg"

response = requests.get(f"https://api.example.com/nft/royalty_status_address/{address}")

print(response.json())

📈 Possible Use Cases

  • Retrieving the current royalty status for a specific address to ensure that all owed royalties have been paid.

  • Displaying the current royalty status for a specific address on a marketplace or portfolio website.

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

PreviousRetrieve Holder Snapshot for NFT 📊 - /nft/holder_snapshotNextRoyalties Status of Multiple NFTs 💰 - /nft/royalty_status_multiple_nfts

Last updated 2 years ago

Was this helpful?