Objects

ActivityResponse

The activity response

Fields

Name	Description
activities [ActivityResult!]!	List of activities
hasMore Boolean!	Are there any more results ?

ActivityResult

An activity result

Fields

Name	Description
nft NFTPreview	The NFT (if any)
collection Collection	The collection (if any)
price Float!	The price for the exchange event
quantity String!	The exchanged quantity
from_address Address!	The user address of the "from" side
from_login String!	The user login (Kalao name) of the "from" side
to_address Address!	The user address of the "to" side
to_login String!	The user login (Kalao name) of the "to" side
transaction_hash String!	The hex transaction hash
url String!	The activity detail page
timestamp Int!	The unix timestamp of the activity event
type ActivityType!	The exchange type (sale, offer, ...)
attributes String!	The attributes the event happened on (i.e. offer on attributes)

ArtistInfo

A user informations

Fields

Name	Description
address Address!	The artist's hex address
name String!	The artist's name
avatar String!	The artist's avatar url
certified Boolean!	If the artist is certified by Kalao
description String!	The profile description
banner String!	The banner (cover) url
amount_traded String	The total traded amount

ArtistStats

An artist statistics object

Fields

Name	Description
sold Int!	Total NFTs already sold
bought Int!	Total NFTs already bought
volume Float!	Total exchange volume value

AttributeDistribution

Attributes distribution on an NFT

Fields

Name	Description
trait_type String!	The attribute key
values [Any!]	The corresponding values
counts [Int!]	The occurences of each value

AuctionBid

The bid type

Fields

Name	Description
buyer_address Address!	The buyer's address
avatar String!	The buyer's avatar
status BidStatus!	The bid status
price Float!	The price
creation_ts Int!	The creation timestamp

AuctionDeal

The auction type

Fields

Name	Description
id String!	The auction id handle
asset_id String!	The NFT id
seller_address Address!	The seller's address
amount Int!	The amount on sale
best_price Float!	The current best price
accepted_price Float!	The final price (when auction is ended)
starting_ts Int!	The unix timestamp for an offer to start
expiration_ts Int!	The unix timestamp for an offer to end

AuctionParameters

The auction parameters needed to bid on

Fields

Name	Description
merkle_root String!	The merkle root is generated by the backend from tokenIds
payment_token String!	The accepted payment token for this auction
expiration_ts Int!	The expiration timestamp
starting_ts Int!	The starting timestamp
token_ids [String!]	The token ids accepted for this auction
next_bid Float!	The minimum accepted price

AuthorizedBasket

A validated (signed) offchain sale

Fields

Name	Description
kind DealKind!	The basket kind (offer or sale)
validated_uuids [String!]!	The uuids of offers/sales that can still be processed
invalidated_uuids [String!]!	The uuids of offers/sales that can't be processed
sales_tickets [SaleTicket]!	The tickets representing sales when basket is a sale basket
offers_tickets [OfferTicket]!	The tickets representing offers when basket is an offer basket

BalancesResult

a balances result

Fields

Name	Description
balances [UserBalance!]!	the balances of users nfts
hasMore Boolean!	Are there any more results ?

BasketCheck

the checkBasket query return (self explanatory)

Fields

Name	Description
valid_uuids [String!]!	the (still) valid sale ids
invalid_uuids [String!]!	the (not longer) valid sale ids

CancelledOffer

A cancelled offer details

Fields

Name	Description
offer_id String!	The unique kalao offer ID
buyer String!	The buyer's hex address
token_address String!	The collection hex address

CancelledOfferTicket

Fields

Name	Description
buyer Address!	the buyer address
token_address Address!	the collection contract address
merkle_root String!	generated by building the merkle tree of tokenIds
payment_token String!	the token address used to pay (KLO , AVAX ..)
amount_to_buy String!	the available amount to buy
unitary_price String!	per token price
expiration_ts Int!	when this offer expires
starting_ts Int!	when this offer start
nonce Int!	a random nonce
chain_id Int!	chain id this offer is on
buyer_signature String!	the buyer sig on above params
offer_id Int!	offer id (used for reconciliation by backend)
validator_signature String!	signature of the validator

CancelledSale

A cancelled sale details

Fields

Name	Description
sale_id String!	The unique kalao sale ID
asset_id String!	The NFT asset id
seller String!	The seller's hex address

CancelledSaleTicket

ticket to force a sale cancellation on KalaoExchange Smart Contract

Fields

Name	Description
seller Address!	the seller 20 bytes eth address
token_address Address!	the exchanged token address
token_id String!	the contract targetted tokenId
in_sale_amount String!	the amount of tokenId to sell
unitary_price String!	self describing ( price are nominated in Wei (10^18) as integers)
expiration_ts Timestamp!	unix timestamp for the sale end
starting_ts Timestamp!	unix timestamp for the sale start
nonce Int!	a ramdom nonce used to validate this sale and needed to buy
chain_id Int!	the chain id this asset is on
min_unitary_price String!	the minimum unitary price (only for managed)
managed Boolean!	If the price is managed by kalao
seller_signature String!	the seller signature on original sale params
validator_signature String!	signature of the validator
sale_id Int!	sale id (used for reconciliation by backend)

CancelsResponse

The cancelled sales and offers on the Kalao Marketplace

Fields

Name	Description
sales [CancelledSale!]!	The cancelled sales
offers [CancelledOffer!]!	The cancelled offers

CancelStatus

A cancellation request status info

Fields

Name	Description
infos String!	A message containing additional cancellation procedure if needed
complete Boolean!	A cancellation is complete if there is no valid tickets at cancellation request time
offer_ticket CancelledOfferTicket	An offer ticket when a call to the smart contract needs to be performed
sale_ticket CancelledSaleTicket	A sale ticket when a call to the smart contract needs to be performed

Category

NFTs collection category (Art, Music, ...)

Fields

Name	Description
name String!	Name of the category
tag String!	Tag (handle) of the category
description String!	A short description
image_url String!	Category illustration url

Collection

An nft collection contract base info

Fields

Name	Description
address Address!	The contract hex address
avatar String!	Avatar url
owner_address Address	The owner hex address if known
name String!	The name
certified Boolean!	If collection is certified
kind String	The collection tokens kind (erc721 or 1155)
creator_address Address	The creator hex address if known
symbol String	The symbol
description String	The description
banner String	The banner (cover) url
launch_art Boolean	If the collection has Launch Art
display_theme CollectionDisplayTheme	The display theme
thumbnails [String!]!	Preview NFT thumbnail urls
twitter String	Twitter url
facebook String	Facebook url
telegram String	Telegram url
discord String	Discord url
instagram String	Instagram url
youtube String	Youtube url
website String	Website url
creator_name String	The creator's name on Kalao

CollectionDetails

A full collection with nfts details

Fields

Name	Description
collection Collection!	The embedded collection
stats CollectionStats!	The collection statistics
attributes_distributions [AttributeDistribution!]	The attributes repartitions

CollectionStats

Collection statistics

Fields

Name	Description
total_minted String!	The collection total NFTs supply
total_owners Int!	The collection number of owners
in_sale Int!	The number of NFTs in sale on Kalao Marketplace
sold Int!	The total number of sales
volume Float!	The exchange volume value
daily_volume Float	The daily exchange volume
weekly_volume Float	The weekly exchange volume
monthly_volume Float	The monthly exchange volume
yearly_volume Float	The yearly exchange volume
floor_price Float!	The price of the cheapest NFT on sale
highest_price Float!	The price of the highest sold NFT
average_price Float!	The average price
average_royalties_percent Float!	The average royalties in percentage

DealsActivities

The activity on an NFT

Fields

Name	Description
listings [DealsActivity!]!	Listings activity
offers [DealsActivity!]!	Offers activity

DealsActivity

A line of listing or offer on an NFT

Fields

Name	Description
id String!	The sale or offer id
price Float!	The exchange price
quantity Int!	The exchanged quantity
from_address String!	The from side user address
from_login String!	The from side user login
to_address String!	The to side user address
to_login String!	The to side user login
expiration Int!	The exchange expiration date
floor_diff String!	The floor diff is the ratio between the sale price and the collection floor price

DealTickets

your tickets to call Kalao XChange contract

Fields

Name	Description
valid_deal_ids [String!]!	the valid sale or offer uuid(s)
invalid_deal_ids [String!]!	the invalid sale or offer uuid(s)
sale_tickets [SaleTicket!]	sale tickets to send to KalaoExchange Smart Contract
offer_tickets [OfferTicket!]	sale tickets to send to KalaoExchange Smart Contract

Graph

A data graph

Fields

Name	Description
nodes [GraphNode!]!	Array of nodes (point coordinates) containing the graph

GraphNode

A node (point) on the graph

Fields

Name	Description
x_coordinate Int!	The utc timestamp of the x coordinate
market_cap Float!	The market cap
average_price Float!	The average price
volume Float!	The volume
floor_price Float!	The floor price
buyers Int!	The number of buyers
sellers Int!	The number of sellers
nfts String!	The number of NFTs
owners Int!	The number of owners
sales Int!	The number of sales
offers Int!	The number of offers
sold Int!	The number of concluded sales

HomeStats

global statistic displayed on front page

Fields

Name	Description
sales Int!	all active sales count on Kalao Marketplace
traded_volume Float!	global trading volume on Kalao Marketplace
staker_fees Float!	KLO token staker fees
APR_farm Float!	KLO token staking Annual Percentage Rate

NFTAttribute

Attributes distribution on an NFT

Fields

Name	Description
trait_type String!	The attribute key
value Any!	The corresponding value
proba Float	The probability of having a nft with this trait_type/value pair

NFTBase

The basic information of an nft

Fields

Name	Description
asset_id String!	Id of the NFT (See AssetId scalar)
token_id String!	The unique token id in its collection
kind String!	The collection kind
address Address!	The collection address
owner Address!	The owner address
editions String!	The editions (1 for erc721, or more for erc1155)
total_owners String!	The total number of unique owners (1 for erc721, or more for erc1155)
owners_avatars [String!]!	A list of the owners' avatars

NFTDetails

An complete NFT object

Fields

Name	Description
base NFTBase!	Base information
sale NFTSalePreview	The sale information if in sale
metadatas NFTMetadatas!	The metadatas and tumbnails
assets NFTMetadataAssets!	All assets
attributes [NFTAttribute!]!	All attributes
collection Collection!	The NFT collection
stats CollectionStats!	The collection statistics
more_nfts [NFTPreview!]!	Other NFTs from the same collection
owner ArtistInfo	The owner information
creator ArtistInfo	The NFT creator information
interactions NFTInteractions	All NFT interactions
best_offer Float	The best offer price
ranking RankingInfo	The ranking of the NFT in the collection

NFTInteractions

All interactions on an NFT

Fields

Name	Description
likes Int!	Likes
favorites Int!	Favorites
views Int!	Views

NFTMetadataAssets

The NFT full assets metadatas information

Fields

Name	Description
raw_image_url String!	Raw image ressource location in ipfs/other
raw_image_mime String!	Raw image ressource mime type in ipfs/other
raw_animation_url String!	Raw animation ressource location in ipfs/other
raw_animation_mime String!	Raw animation ressource mime type in ipfs/other
hd_image_url String!	Processed image ressource location in cdn
hd_image_mime String!	Processed image ressource mime type in cdn
hd_animation_url String!	Processed animation ressource location in cdn
hd_animation_mime String!	Processed animation ressource mime type in cdn

NFTMetadatas

The NFT parsed metadatas

Fields

Name	Description
name String!	The token name
description String!	The description
thumbnail_url String!	The processed thumbnail url
thumbnail_mime String!	The processed thumbnail mime type
animation_url String	The nft animation url
background_color String!	The background color (if any)
external_url String!	The external url (if any)
youtube_url String!	The youtube url (if any)
extra String	The extra non standard metadatas

NFTOfferPreview

An NFT on offer informations

Fields

Name	Description
offer_id String!	The offer unique id
kind OfferKind!	The offer kind
side OfferSide!	The offer side (sent or received)
merkle_root String!	The merkle root (used with attributes kind collection offering)
attributes String	Attributes if any
payment_token String!	The payment token address (WAVAX, KLO, ...)
buyer Address!	The buyer's hex address
unitary_price String!	The unitary price in WEI
unitary_price_float Float!	The unitary price in ETH
quantity String!	The amount in sale
bought_quantity String!	The bought quantity
total_quantity String!	The total quantity to buy
start_date Int!	The sale start date
expiration_date Int!	The sale end date
status OfferStatus!	The offer status (active, inactive or cancelled)
floor_diff String!	The floor diff is the ratio between the offer price and the collection floor price

NFTPreview

An nft preview

Fields

Name	Description
asset_id String!	Id of the NFT (See AssetId scalar)
token_id String!	The unique token id in its collection
name String!	The nft token name from metadatas
collection Collection!	The collection infos
thumbnail String!	The nft medias thumbnail
animation_url String	The nft animation url
animation_mime String	The nft animation mime type
likes Int!	The number of 'like' interactions on Kalao
sale NFTSalePreview	The sale info if the NFT is in sale
offer NFTOfferPreview	The offer info if the NFT has an offer
rank Int	The ranking of the nft in its collection
balance String	The balance of the asset

NFTSalePreview

An NFT on sale informations

Fields

Name	Description
sale_id String!	Unique sale id
seller Address!	The seller's address
unitary_price String!	The unitary price in WEI
unitary_price_float Float!	The unitary price in ETH
top_bid_float Float	The top bid in ETH
quantity String!	The amount in sale
start_date Int!	The sale start date
expiration_date Int!	The sale end date
kind SaleKind!	The sale kind (auction or direct)
status SaleStatus!	The sale status (live, sold out, ended or cancelled)
floor_diff String!	The floor diff is the ratio between the sale price and the collection floor price

OffChainOffer

A buy offer

Fields

Name	Description
id ID!	the unique offer ID (uuid v4)
exchange_address String!	the exchange contract address
buyer Address!	the buyer address
token_address Address!	the collection contract address
merkle_root String!	generated by backend from tokenIds
payment_token String!	the token address used to pay (KLO , AVAX ..)
amount_to_buy String!	the available amount to buy
unitary_price String!	per token price
unitary_price_float Float!	price in human readable format
expiration_ts Int!	when this offer expires
starting_ts Int!	when this offer start
nonce Int!	a random nonce
chain_id Int!	chain id this offer is on
buyer_signature String!	the buyer sig on above params
token_ids [String!]	requested token ids if not the entire collection

OfferTicket

A validated offer ticket

Fields

Name	Description
buyer Address!	The buyer address
token_address Address!	The collection contract address
merkle_root String!	Generated by backend from tokenIds
payment_token String!	The token address used to pay (KLO , AVAX ..)
amount_to_buy String!	The available amount to buy
unitary_price String!	The price of an NFT for sale
expiration_ts Int!	The expiration timestamp
starting_ts Int!	The starting timestamp
nonce Int!	A random nonce
chain_id Int!	chain id this offer is on
buyer_signature String!	The buyer sig on above params
merkle_proof [String!]!	The merkle proof is used when offer is for multiple token Ids
seller Address!	The seller / owner of the nfts being bought
token_id String!	The token id being bought
amount_sold String!	The amount sold for token_id
fees_kalao String!	Fees for kalao on this offer
fees_community String!	Fees for kalao community on this offer
fees_extern String!	Fees for external partner / org on this offer
extern_recipient String!	External partner / org address
validator_signature String!	The backend signature on this offer
validator_signature_expiration_ts Int!	Backend signature expiration
offer_id Int!	This offer serial id
activate_royalties Boolean!	If royalties are activated

ProofResponse

A generated merkleroot proof for attributes offers

Fields

Name	Description
token_ids [String!]!	The list of token ids
merkleroot String!	The merkle root

RankingInfo

The ranking information of an NFT

Fields

Name	Description
rank Int!	The rank in the collection
rarity Float!	The Kalao computed rarity

RankingResponse

A ranking response

Fields

Name	Description
items [RankingResult!]!	List of ranking results
hasMore Boolean!	Are there any more results ?
count Int!	The number of results

RankingResult

A line of ranking result

Fields

Name	Description
collection Collection	For RankingTarget.collection
collection_stats CollectionStats	For RankingTarget.collection
user ArtistInfo	For RankingTarget.user
user_stats ArtistStats	For RankingTarget.user
rank Int!	The numeric rank value
graph Graph!	The RankingTarget graphical values

SaleTicket

A validated sale ticket

Fields

Name	Description
seller Address!	The seller's address
token_address Address!	The collection address
token_id String!	The NFTs token id in collection
in_sale_amount String!	The amount for sale
unitary_price String!	The price of an NFT for sale
expiration_ts Timestamp!	The expiration timestamp
starting_ts Timestamp!	The starting timestamp
nonce Int!	A random nonce
chain_id Int!	The chain id the sale is on
min_unitary_price String!	The starting price
managed Boolean!	If the sale is managed
seller_signature String!	The seller signature
buyer Address!	The buyer's address
nft_recipient String!	nft_recipient
amount_bought String!	The amount bought
sale_id Int!	The sale id
kalao_fees String!	The amount of fees for Kalao
community_fees String!	Fees for kalao community on this sale
extern_fees String!	Fees for external partner / org on this offer
extern_recipient String!	External partner / org address
validator_signature_expiration_ts Timestamp!	Backend signature expiration
activate_royalties Boolean!	If royalties are activated
validator_signature String!	The backend signature on this offer

SearchResults

A search request result

Fields

Name	Description
collections [CollectionDetails!]!	For search target = collection
artists [ArtistInfo!]!	For search target = artists
nfts [NFTPreview!]!	For search target = nfts, sales or collectibles
hasMore Boolean!	Are there any more results ?

SessionInfos

Session information

Fields

Name	Description
logged_in Boolean!	authentication status
address Address	connected address

TopBidResponse

A list of bids

Fields

Name	Description
top_bid Float!	The top bid price
bids [AuctionBid!]!	The bids

User

a user profile (could be an artist !)

Fields

Name	Description
name String!	user pseudonym
address Address!	user hex address
avatar String!	profile avatar url
certified Boolean!	certification status for an artist

UserBalance

an address (user) nfts balance

Fields

Name	Description
nft NFTPreview!	nft details
balance String!	balance (1 for erc721, more for erc1155)
available_amount String!	not in sale balance (available to sell)
kalao_exchange_approved Boolean!	is Kalao Exchange contract able to operate the nft (Web3 approve method)

UserDashboardStatistics

Fields

Name	Description
wallet_value String!
amount_traded String!
available_offers String!
ratio_purchase_sale String!
purchases String!
sales String!

UserMetadata

user metadata to display on his profile page

Fields

Name	Description
followers Int!	number of kalao profile followers
following Int!	number of followed profiles
owned_nfts Int!	number of owned nfts
liked_nfts Int!	number of nft liked by the user

UserProfile

A marketplace user or artist

Fields

Name	Description
address Address!	user hex address (aka your wallet address)
name String!	user pseudonym
login String!	user VR Application login
description String!	user / artist profile description
mail String!	user mail address
avatar String!	profile avatar url
cover String!	profile cover / banner url
twitter String!	twitter profile url
facebook String!	facebook page / profile url
instagram String!	instagram profile url
telegram String!	telegram profile / channel url
website String!	website url
youtube String!	youtube channel / profile url
discord String!	discord url
certified Boolean!	certification status
metadata UserMetadata!	user metas
stats UserDashboardStatistics!	user statistics

VolumeStatistics

A global marketplace volume statistic

Fields

Name	Description
collections Int!	Number of available collections
nfts_on_sale Int!	Current number of nfts sales
artists Int!	Certified user count