Skip to content

Latest commit

 

History

History
120 lines (62 loc) · 4.81 KB

mintbase-graph.md

File metadata and controls

120 lines (62 loc) · 4.81 KB

📊 GraphQL Indexer

This is our preferred option as it is probably the most flexible option and allows an easy schema exploration.

Endpoints

NetworkEndpoint
mainnethttps://graph.mintbase.xyz/mainnet
testnethttps://graph.mintbase.xyz/testnet

Use GraphiQL

NetworkURL
mainnet

https://cloud.hasura.io/public/graphiql?endpoint=https%3A%2F%2Fgraph.mintbase.xyz%2Fmainnet&header=mb-api-key:anon
testnethttps://cloud.hasura.io/public/graphiql?endpoint=https%3A%2F%2Fgraph.mintbase.xyz%2Ftestnet&header=mb-api-key:anon

The queries and relationships are extensible, we suggest just clicking around the tree to make the queries and it will become easy over time.

API Key

In the future, users may be required to register using an api key. For now, simply passing the valueanon for mb-api-key will work: e.g.

curl --location --request POST 'https://graph.mintbase.xyz' \
--header 'mb-api-key: anon' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"query blocks {\n    blocks {\n        synced_height\n    }\n}","variables":{}}'

Examples

  1. Get NFTs owned by an account, notice the burned_timestamp if null indicates it has not been burned yet
  2. Get Metadata from token reference including title, media, documents, sound, 3d.
  3. Get unburned tokens on a contract

{% embed url="https://cloud.hasura.io/public/graphiql?endpoint=https%3A%2F%2Fgraph.mintbase.xyz%2Fmainnet&header=mb-api-key%3Aanon&query=query+MyQuery+%7B%0A++mb_views_nft_tokens%28%0A++++where%3A+%7Bowner%3A+%7B_eq%3A+%22nate.near%22%7D%2C+_and%3A+%7Bburned_timestamp%3A+%7B_is_null%3A+true%7D%2C+last_transfer_timestamp%3A+%7B_is_null%3A+false%7D%7D%7D%0A++++limit%3A+30%0A++++order_by%3A+%7Blast_transfer_timestamp%3A+desc%7D%0A++%29+%7B%0A++++nft_contract_id%0A++++title%0A++++description%0A++++media%0A++++last_transfer_receipt_id%0A++%7D%0A%7D%0A" %}

Query Formatting

Find all the different entities and parameters for interacting with the API.

Core Entities

  • nft_tokens: Gets data on single tokens
  • mb_views_nft_metadata_unburned: The token type (metadata wrapper)
  • nft_metadata: Indexed metadata
  • nft_contracts: Stores/contracts deployed
  • nft_listings: Marketplace listings
  • offers: Offers made to market listings
  • mb_store_minters: Allowed mintings accounts
  • nft_earnings: Historical earnings per account

Aggregated Entities

...

Query Parameters

...

Pagination Parameters

offset: position where it should start the results ex:
offset : 12
it will render results from 12 > \

Query Examples

GetTokenById

Query to retrieve a specific nft/Token

you need tokenId , and contractAddress
ex:
tokenId: 137
contract Address: voiceoftheoceans.mintbase1.near\

{% embed url="https://gist.github.com/rubenmarcus/c781422542c19cfaca4bbc3a74ffad81#file-gettokenbyid" %}

GetStoreNfts

{% embed url="https://gist.github.com/rubenmarcus/c781422542c19cfaca4bbc3a74ffad81#file-getstorenfts" %}

GetStoreDataById

{% embed url="https://gist.github.com/rubenmarcus/c781422542c19cfaca4bbc3a74ffad81#file-getstoredatabyid" %}


GetRoyaltiesInfo

{% embed url="https://gist.github.com/rubenmarcus/c781422542c19cfaca4bbc3a74ffad81#file-getroyaltiesinfo" %}


GetTokensSplitbyMetadataId

{% embed url="https://gist.github.com/rubenmarcus/1ea704327c252f198eef7fc6d9eebecd#file-gettokenssplitbymetadataid" %}

Demo