Input objects

ActivityRequest

The activity request input

Arguments

Name	Description
target ActivityTarget!	Filter on the activity target
user_address Address	Filter on a particular user
collection_address Address	Filter on a collection
asset_id String	Filter on an NFT
types [ActivityType!]!	Select the activity types to get (sales, offers, ...)
days_filter DaysFilter	Fiter on a period

AttributesQuery

NFT attributes search format (key / value)

Arguments

Name	Description
trait_type String!	Trait name (key)
value Any!	Trait value (value)

BalancesRequest

a balances request

Arguments

Name	Description
user_address Address!	the user hex address
collection_address Address	optional collection hex address
keywords String	optional search keywords
sort SearchNftSort	optional sort by method

BasketItem

An item in basket (NFT)

Arguments

Name	Description
id String!	The selected sale/offer id
amount String!	The amount the buyer/seller wants to buy/sell 1 if erc721 or 0>x>amount_in_sale for the rest
token_id String	The accepted token id if dealKind = offer on collection

BasketRequest

An nft basket

Arguments

Name	Description
kind DealKind!	The kind of basket (offer or sale)
basket [BasketItem!]!	A key(string) / value(string) object representing a saleId as key and amount as value
buyer_address Address	the buyer address (consumeSaleBasket case)
seller_address Address	the seller address (consumeOfferBasket case)

CancelRequest

A cancellation request input

Arguments

Name	Description
kind DealKind!	The kind (offer, cancel or sale cancel)
uuid String!	The uuid of the offer/sale to cancel

CollectionInfoUpdate

Arguments

Name	Description
address Address!	the needed hex address of the collection to update
description String	an inspiring description
twitter String	a twitter url
telegram String	a telegram channel url
discord String	a discord url
website String	collection website url
instagram String	instagram profile url
facebook String	facebook page url
youtube String	youtube channel or video url

CollectionNftsSearchRequest

a collection nft search request

Arguments

Name	Description
address Address!	collection address
keywords String	search text entry
properties [String!]	nfts has properties
attributes [AttributesQuery!]	find nft attributes
on_sale Boolean	on sale or not
price_range Range	self explanatory
owner Address	find by owner
sort SearchNftSort	sort results

DealRequest

Depending on the kind either sale or offer input has to be present

Arguments

Name	Description
kind DealKind!	Deal kind
sale OffChainSaleInput	Create a sale offering from your assets
offer OfferInput	Make an offer for a particular collection or collection NFTs

OffChainSaleInput

init a "backend signed" sale creation

Arguments

Name	Description
asset_id String!	the token sold internal UPC
token_address Address!	the token public eth contract address
token_id String!	the nft token id public field
seller Address!	this sale offer creator eth address
in_sale_amount String!	amount sold if item is fractionable
unitary_price String!	self descriptive
starting_ts Timestamp!	a unix timestamp for an offer to start
expiration_ts Timestamp!	a unix timestamp for an offer to end
nonce Int!	some random nonce obtained by nonce() query
chain_id Int!	the chain-id you are on (fuji : 43113)
min_unitary_price String!	the minimum unitary price (only for managed)
managed Boolean!	If the price is managed by kalao
signature String!	the seller signature on the above parameters

OfferInput

A buy request offer for a token id in collection

Arguments

Name	Description
buyer Address!	The buyer address
token_address Address!	The address of the token collection contract
merkle_root String!	The merkle root of accepted token ids
payment_token String!	The payment token contract address (ETH / wETH / Avax ...)
amount_to_buy String!	The total amount bought (more than 1 for erc1155 for example)
unitary_price String!	The unitary price in WEI
expiration_ts Timestamp!	When this buy offer expires
starting_ts Timestamp!	When this buy offer starts
nonce Int!	A ramdom nonce
chain_id Int!	The chain we're on
token_ids [String!]	The tokenIds (could be empty if creating an offer for a full collection)
buyer_signature String!	The buyer signature on the above parameter keccak256 hashed
attributes String	If offer is on attributes

Page

set page and items per page

Arguments

Name	Description
page Int
size Int

Range

Range for min and max

Arguments

Name	Description
min Float	Low value of range
max Float	High value of range

RankingRequest

A ranking request

Arguments

Name	Description
target RankingTarget!	The kind of ranking
category_tags [String!]	Filter on collection categories
days_filter DaysFilter!	Filter on a period

SearchRequest

A global search request

Arguments

Name	Description
target SearchTarget!	Search target (nfts, collections, ...)
keywords String	Full text search entry parameter
certified Boolean	Filter only on certified users or collections
category_tags [String!]	Filter by category
attributes [AttributesQuery!]	Filter by attributes
sale_type SaleKind	Sale type (auction or direct)
price_range Range	Filter sales by their price range
token_kind String	Filter by token kind (erc721 or erc1155)
owner Address	Filter by owner (to be used for the target collectibles)
sort SearchNftSort	Results sorting key
collection_address Address	Filter by collection address
creator Address	Filter by creator address

UserModif

a user profile update input

Arguments

Name	Description
mail String	set or update profile email
name String	set or update profile pseudonym
description String	set or update profile description
phone String	set or update profile phone number
twitter String	set or update profile twitter url
facebook String	set or update profile facebook url
instagram String	set or update profile instagram url
telegram String	set or update profile telegram url
website String	set or update profile website url
youtube String	set or update profile youtube url
discord String	set or update profile discord url