Skip to main content

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.

NFT with Slots

Single Entity

This query is an example of how to get an entity's information.

Request URL: 'https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest'
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.

Request URL: 'https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest'
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.

Request URL: 'https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest'
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.

Request URL: 'https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest'
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.

Request URL: 'https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest'
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.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
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.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
query Templates {
templates {
id
uri
templateId
price
mintedCount
category
}
}

NFT Smart Contract Balance

Queries and returns the balance of a given NFT smart contract.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
query CollectionsBalance {
entityCollections {
address
balance
protocolBalance
protocolWithdrawnAmount
totalWithdrawnAmount
royalty
}
}

mQuark Contract Addresses

Queries and returns deployed and active mQuark contract addresses.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
query Contracts {
addresses {
id
controller
imported
registry
subscriber
template
}
}

Controller Contract

Queries and returns the Controller contract's information.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
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.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
query EntityImportedCollections {
mquarkEntities {
id
importedCollections {
id
collectionId
entityId
templateId
}
}
}

Registry Contract

Queries and returns the Registry contract's information.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
query Registry {
registries {
id
subscriber
controller
}
}

Subscriber Contract

Queries and returns the Subscriber contract's information.

Request URL: https://api.studio.thegraph.com/query/35629/mquark-testnet-v1/version/latest
query Subscriber {
subscribers {
id
royalty
registry
protocolBalance
importedContracts
controller
}
}