API Reference
The mQuark provides easy Graph APIs to developers, so they can build and extend upon our protocol in the simplest way possible. All developers can query the following API endpoints through the graph protocol. Protocol’s state and information is open and transparent to the public.
Single Entity
This query is an example of how to get an entity's information.
query Entity($_id: ID!) {
mquarkEntity(id: $_id) {
id
entityId
name
description
thumbnail
contractAddress
defaultURI
owner
subscriptionPrice
subscriptionBalance
verifier
}
}
Entity Collections
Returns an entity's created collections.
query EntityCollections($_id: ID!) {
mquarkEntity(id: $_id) {
createdCollections {
id
entityId
collectionId
templateId
address
controller
verifier
template {
id
templateId
uri
category
}
balance
royalty
mintType
mintPrice
mintLimit
totalSupply
mintedCount
dynamic
free
whitelisted
collectionURIs
protocolBalance
protocolWithdrawnAmount
witdrawnAmount
totalWithdrawnAmount
}
}
}
Entity Collection
Returns an entity's created collection.
query EntityCollections($_id: ID!) {
mquarkEntity(id: $_id) {
createdCollections {
id
entityId
collectionId
templateId
address
controller
verifier
template {
id
templateId
uri
category
}
balance
royalty
mintType
mintPrice
mintLimit
totalSupply
mintedCount
dynamic
free
whitelisted
collectionURIs
protocolBalance
protocolWithdrawnAmount
witdrawnAmount
totalWithdrawnAmount
}
}
}
All Entites
Returns all entities' information.
query AllEntities {
mquarkEntities {
id
entityId
name
description
contractAddress
defaultURI
thumbnail
owner
verifier
subscriptionBalance
subscriptionPrice
}
}
NFT Owner
Queries and returns all NFTs owned by a given address.
query Owner($_id: ID!) {
owner(id: $_id) {
id
quarks {
id
tokenId
collectionId
contractAddress
entityId
templateId
immutableUri
isLocked
subscriptions {
id
asset
}
}
}
}
mQuark NFT
Queries and returns a given NFT's information.
query Token($_id: ID!) {
mquarkToken(id: $_id) {
id
tokenId
templateId
entityId
isLocked
immutableUri
contractAddress
collectionId
subscriptions {
asset
contractAddress
}
owner {
id
}
}
}
Templates
Queries and returns all templates.
query Templates {
templates {
id
uri
templateId
price
mintedCount
category
}
}
NFT Smart Contract Balance
Queries and returns the balance of a given NFT smart contract.
query CollectionsBalance {
entityCollections {
address
balance
protocolBalance
protocolWithdrawnAmount
totalWithdrawnAmount
royalty
}
}
mQuark Contract Addresses
Queries and returns deployed and active mQuark contract addresses.
query Contracts {
addresses {
id
controller
imported
registry
subscriber
template
}
}
Controller Contract
Queries and returns the Controller contract's information.
query Controller {
controllers {
id
template
subscriber
royalty
registry
authorizedWithdrawal
}
}
Implementation Contract Addresses
Queries and returns all deployed and active mQuark implementation contract addresses.
query Implementations {
implementations {
id
address
}
}
Entities' Imported Contracts
Queries and returns all entities' imported contracts.
query EntityImportedCollections {
mquarkEntities {
id
importedCollections {
id
collectionId
entityId
templateId
}
}
}
Registry Contract
Queries and returns the Registry contract's information.
query Registry {
registries {
id
subscriber
controller
}
}
Subscriber Contract
Queries and returns the Subscriber contract's information.
query Subscriber {
subscribers {
id
royalty
registry
protocolBalance
importedContracts
controller
}
}