Skip to content

Types

BigFloat

Description

A binary integer decimal representation of a 128-bit decimal value, supporting 34 decimal digits of significand and an exponent range of -6143 to +6144.

Example
js
987.65

Types

BigInt

Description

Defines a Long class for representing a 64-bit two’s-complement integer value.

Example
js
987

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
js
true

Types

Currency

Description

Represents a currency, can be used to display pricing unit.

Fields
Field NameDescription
code - String!Country currency code, defines alpha codes and numeric codes for the representation of currencies. This field follow ISO 4217 code list.
symbol - String!The currency symbol or currency sign is a graphic symbol used to denote a currency unit.
Example
js
{
  "code": "xyz789",
  "symbol": "abc123"
}

Types

Date

Description

ISO 8601 date format. The timezone is always zero UTC offset, as denoted by the suffix Z. Milliseconds since epoch is an alternative input format.

Example
js
"Thu Jul 13 2023 13:27:11 GMT+0200"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
js
123.45

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
js
987

Types

JSONObject

Description

Represent a JSON object.

Example
js
{"someProperty": "myStringValue", "otherProperty": 987}

Types

JSONPrimitive

Description

Represent all supported primitive type for json object.

Example
js
"true | "myStringValue" | 987 | 987.65"

Types

MonetaryAmount

Description

The MonetaryAmount object represents a monetary value using a currency's unit.

Fields
Field NameDescription
amount - BigFloat!Amount value with a precision of 8 digits.
currency - Currency!Currency unit related to the amount.
Example
js
{"amount": 987.65, "currency": Currency}

Types

Pagination

Description

Pagination applied to the result. Maximum limit allowed result per page is 25.

Fields
Field NameDescription
limit - Int!Maximum number of expected results per page. Mandatory field.
skip - Int!Number of results skipped. Mandatory field.
Example
js
{"limit": 987, "skip": 123}

Types

PaginationInput

Description

Pagination filter. Used as query argument, it's optional filter. If not provided, default pagination will be applied with skip value to 0 and limit to 25 maximum results per page.

Fields
Input FieldDescription
limit - IntNumber of wanted results per page. Optional field.
skip - IntNumber of results to skip.s Optional field.
Example
js
{"limit": 987, "skip": 987}

Types

StreamCursor

Description

An opaque string used to resume a stream.

Example
js
"0"

Types

StreamPosition

Description

The stream position.

Values
Enum ValueDescription
CURSORThe stream position was resumed after the given cursor position.
EARLIESTThe stream position was set to the earliest position if no cursor provided or the given cursor is unreachable.
LATESTThe stream position was set to the latest position if no cursor provided or the given cursor is unreachable.
Example
js
"CURSOR"

Types

StreamPositionStrategy

Description

The stream position strategy.

Values
Enum ValueDescription
EARLIESTAutomatically set the stream position to the earliest position. The stream entries are emitted with position between [earliest .. latest + n).
LATESTAutomatically set the stream position to the latest position. The stream entries are emitted with position between [latest .. latest + n).
Example
js
"EARLIEST"

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
js
"xyz789"

Types

Uniq

Description

The Uniq object represents all information about a uniq.

Fields
Field NameDescription
factory - UniqFactory!Information on factory related to this uniq.
id - BigInt!On chain id of the uniq.
metadata - UniqMetadata!Information on uniq metadata.
mintDate - Date!Date of uniq mint.
owner - WalletId!WalletId of the uniq owner.
resale - UniqResaleInformation about the uniq resale. Null means not on sale.
serialNumber - BigInt!Serial number of the uniq.
tradingPeriod - UniqTradingPeriodWindow time which trading actions are allowed. Null means not tradable
transferPeriod - UniqTransferPeriodWindow time which transfer actions are allowed. Null means not transferable
type - UniqType!Specify the type of the uniq asset.
Example
js
{
  "factory": UniqFactory,
  "id": 987,
  "metadata": UniqMetadata,
  "mintDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "owner": "aa1aa2aa3ag4",
  "resale": UniqResale,
  "serialNumber": 987,
  "tradingPeriod": UniqTradingPeriod,
  "transferPeriod": UniqTransferPeriod,
  "type": "COLLECTIBLE"
}

Types

UniqDynamicResource

Description

The UniqDynamicResource object represents a resource, it's an image, video or a file. It can be refreshed to discover changes.

Fields
Field NameDescription
contentType - String!Type of resource image,video etc.
uris - [String!]!Uris where the resource is stored.
Example
js
{
  "contentType": "abc123",
  "uris": ["abc123"]
}

Types

UniqFactory

Description

The UniqFactory object represents all information about a uniq factory.

Fields
Field NameDescription
accountMintingLimit - BigIntThe number of minting limit per account.
assetCreator - WalletId!Wallet id of who created the uniq factory.
assetManager - WalletId!Wallet id of whom manages the uniq lifecycle - issuing, burning, reselling etc.
conditionlessReceivers - [WalletId!]!A set of receiver account which uniqs can be transferred to without any restrictions. Without taking in account the trading windows, minimum resell price, etc.
defaultUniqMetadata - UniqMetadatauniq default metadata are utilized whenever any token is the reference that does not have a dedicated metadata uri. this can happen either intentionally if the tokens minted from the factory are identical (so there is no need for anything except default metadata) or accidentally in case due to some issue, tokens are minted without a dedicated metadata URI. In any case, the default metadata function identically to individual Uniq metadata with only exceptions that it is utilized when there is no override and the URI for this metadata is placed in the dedicated field of the factory on-chain data default_token_uri. It can be used as a fallback when uniq metadata is not yet available.
id - BigInt!On chain id of the uniq factory.
metadata - UniqFactoryMetadata!Metadata information of the uniq factory.
mintableWindow - UniqFactoryMintableWindow!Period of time which minting actions are allowed.
resale - UniqFactoryResale!Information about resale operations that will be applied on uniqs on the second hand market.
status - UniqFactoryStatus!The uniq factory on chain status.
stock - UniqFactoryStock!Information about the circulation quantity of uniqs related to the factory.
tradingWindow - UniqFactoryTradingWindow!Period of time which trading actions are allowed.
transferWindow - UniqFactoryTransferWindow!Period of time which transfer actions are allowed.
type - UniqType!Specify the type of the uniq factory asset.
Example
js
{
  "accountMintingLimit": 987,
  "assetCreator": "aa1aa2aa3ag4",
  "assetManager": "aa1aa2aa3ag4",
  "conditionlessReceivers": [
    "aa1aa2aa3ag4"
  ],
  "defaultUniqMetadata": UniqMetadata,
  "id": 987,
  "metadata": UniqFactoryMetadata,
  "mintableWindow": UniqFactoryMintableWindow,
  "resale": UniqFactoryResale,
  "status": "ACTIVE",
  "stock": UniqFactoryStock,
  "tradingWindow": UniqFactoryTradingWindow,
  "transferWindow": UniqFactoryTransferWindow,
  "type": "COLLECTIBLE"
}

Types

UniqFactoryActionWindow

Description

Interface for actions on a window period.

Fields
Field NameDescription
endDate - Date
startDate - Date
Possible Types
UniqFactoryActionWindow Types
UniqFactoryMintableWindow
UniqFactoryTradingWindow
UniqFactoryTransferWindow
Example
js
{
  "endDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "startDate": "Thu Jul 13 2023 13:27:11 GMT+0200"
}

Types

UniqFactoryDigest

Description

The UniqFactory digest object represents all immutable informations about a uniq factory.

Fields
Field NameDescription
assetCreator - WalletId!Wallet id of who created the uniq factory.
assetManager - WalletId!Wallet id of whom manages the uniq lifecycle - issuing, burning, reselling etc.
id - BigInt!On chain id of the uniq factory.
maxMintableUniqs - BigIntThe maximal number of uniq that can be minted with the factory. Null means infinite.
mintableWindow - UniqFactoryMintableWindow!Period of time which minting actions are allowed.
resale - UniqFactoryResale!Information about resale operations that will be applied on uniqs on the second hand market.
tradingWindow - UniqFactoryTradingWindow!Period of time which trading actions are allowed.
transferWindow - UniqFactoryTransferWindow!Period of time which transfer actions are allowed.
type - UniqType!Specify the type of the uniq factory asset.
Example
js
{
  "assetCreator": "aa1aa2aa3ag4",
  "assetManager": "aa1aa2aa3ag4",
  "id": 987,
  "maxMintableUniqs": 987,
  "mintableWindow": UniqFactoryMintableWindow,
  "resale": UniqFactoryResale,
  "tradingWindow": UniqFactoryTradingWindow,
  "transferWindow": UniqFactoryTransferWindow,
  "type": "COLLECTIBLE"
}

Types

UniqFactoryList

Description

The UniqFactoryList object represents a list of uniq factory with pagination information.

Fields
Field NameDescription
data - [UniqFactory!]!List of factory results.
pagination - Pagination!Pagination applied.
totalCount - Int!Total number of uniq factory results.
Example
js
{
  "data": [UniqFactory],
  "pagination": Pagination,
  "totalCount": 987
}

Types

UniqFactoryMetadata

Description

The UniqFactoryMetadata object represents global metadata information related to a uniq factory.

Fields
Field NameDescription
cachedSource - UniqResourceCopy of the source metadata inside ultra system. Optimized access to the metadata file, should be preferred over source field if provided. Null if not stored yet into ultra system.
content - UniqFactoryMetadataContentResolved content of the metadata file, ideal to display all metadata information about a uniq factory. Null if not resolved yet.
locked - Boolean!Metadata modification allowed. False means metadata can change over the time. True means metadata are immutable and cannot be changed.
source - UniqResource!All information related to the source of the metadata information.
status - UniqMetadataStatus!Internal status of verification and caching metadata into ultra system. It can be used to know if the metadata content is available/displayable.
Example
js
{
  "cachedSource": UniqResource,
  "content": UniqFactoryMetadataContent,
  "locked": false,
  "source": UniqResource,
  "status": "INVALID"
}

Types

UniqFactoryMetadataAttribute

Description

The UniqFactoryMetadataAttribute object represents a key value store describing attributes available for uniqs related to a factory.

Fields
Field NameDescription
key - String!Key that allow to retrieve the attribute.
value - UniqMetadataAttributeDescriptor!Information details about the attribute.
Example
js
{
  "key": "xyz789",
  "value": UniqMetadataAttributeDescriptor
}

Types

UniqFactoryMetadataContent

Description

The UniqFactoryMetadataContent object represents the content that follows the uniq factory metadata structure of the NFT standard.

Fields
Field NameDescription
attributes - [UniqFactoryMetadataAttribute!]This field allows you to specify structured numeric or string data for the factory.
description - StringA detailed explanation about what this factory represents, mints and/or used for.
medias - UniqMedias!Contains the media used to display this factory. Refer to Metadata media for more details.
name - String!Name of the factory as a whole. Can represent the collection name.
properties - JSONObjectAn arbitrary data that you can supply that does not fit any other category.
resources - [UniqMetadataResource!]Allows additional media or reference data to be added as a part of the metadata.
subName - StringAn additional flavor name used to describe this Uniq factory.
Example
js
{
  "attributes": [UniqFactoryMetadataAttribute],
  "description": "xyz789",
  "medias": UniqMedias,
  "name": "abc123",
  "properties": {"someProperty": "myStringValue", "otherProperty": 987},
  "resources": [UniqMetadataResource],
  "subName": "abc123"
}

Types

UniqFactoryMintableWindow

Description

The UniqFactoryMintableWindow object represents a period of time when a uniq can be minted from a factory. [no start, no end], forever mintable. [no start, end], can only be minted before the ending date. [start, no end], can only be minted after the starting date. [start, end], can only be minted between the start and end dates

Fields
Field NameDescription
endDate - DateThe end of the time period when uniq can be minted. Null means no ending date to mint a uniq.
startDate - DateThe beginning of a time period when uniq can be minted. Null means no starting date to mint a uniq.
Example
js
{
  "endDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "startDate": "Thu Jul 13 2023 13:27:11 GMT+0200"
}

Types

UniqFactoryResale

Description

The UniqFactoryResale object represents information about second hand market resale operations that will be applied to a uniq related to this factory.

Fields
Field NameDescription
minimumPrice - MonetaryAmount!The minimum price allowed when a resell is performed on a secondhand marketplace.
shares - [UniqSaleShare!]!A vector of [account, share] pairs setting the share each account receives during the token resale. Total limit to 7000 basis_point or 70%. The receiver can be duplicated.
Example
js
{
  "minimumPrice": MonetaryAmount,
  "shares": [UniqSaleShare]
}

Types

UniqFactorySnapshot

Description

The Uniq Factory Snapshot.

Fields
Field NameDescription
cursor - StreamCursorThe optional stream cursor to resume snapshots after.
id - BigInt!On chain id of the uniq factory.
position - StreamPosition!The stream position.
state - UniqFactoryThe optional state, null means deleted.
Example
js
{
  "cursor": "0",
  "id": 987,
  "position": "CURSOR",
  "state": UniqFactory
}

Types

UniqFactoryStatus

Description

Uniq factory on chain status.

Values
Enum ValueDescription
ACTIVEOn chain value 0 = active - fully functional
INACTIVEOn chain value 1 = inactive - cannot mint
SHUTDOWNOn chain value 2 = shutdown - cannot mint or set active
Example
js
"ACTIVE"

Types

UniqFactoryStock

Description

The UniqFactoryStock object represents quantity available for minting purpose.

Fields
Field NameDescription
authorized - BigIntThe number of uniq authorized by the asset_manager to be minted by authorized minters.
existing - BigInt!The number circulating uniqs, corresponding to minted uniq minus number of burnt uniq.
maxMintable - BigIntThe maximal number of uniq that can be minted with the factory. Null means infinite.
mintable - BigIntThe number of uniq left that can be minted. Null means infinite.
minted - BigInt!The total number of minted uniq.
Example
js
{
  "authorized": 987,
  "existing": 987,
  "maxMintable": 987,
  "mintable": 987,
  "minted": 987
}

Types

UniqFactoryTradingWindow

Description

The UniqFactoryTradingWindow object represents a period of time when a uniq can be traded. [no start, no end], forever tradable. [no start, end], can only be traded before the ending date. [start, no end], can only be traded after the starting date. [start, end], can only be traded between the start and end dates It's being checked when a buy/resell action is performed.

Fields
Field NameDescription
endDate - DateThe end of a time period when uniq can be traded. Null means no ending date to trade a uniq.
startDate - DateThe beginning of a time period when uniq can be traded. Null means no starting date to trade a uniq.
Example
js
{
  "endDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "startDate": "Thu Jul 13 2023 13:27:11 GMT+0200"
}

Types

UniqFactoryTransferWindow

Description

The UniqFactoryTransferWindow object represents a period of time when a uniq can be transferred. [no start, no end], forever transferable. [no start, end], can only be transferred before the ending date. [start, no end], can only be transferred after the starting date. [start, end], can only be transferred between the start and end dates It's being checked when a transfer action is performed.

Fields
Field NameDescription
endDate - DateThe end of a time period when uniq can be transferred. Null means no ending date to transfer a uniq.
startDate - DateThe beginning of a time period when uniq can be transferred. Null means no starting date to transfer a uniq.
Example
js
{
  "endDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "startDate": "Thu Jul 13 2023 13:27:11 GMT+0200"
}

Types

UniqList

Description

The UniqList object represents a list of uniq with pagination information.

Fields
Field NameDescription
data - [Uniq!]!List of uniq results.
pagination - Pagination!Pagination applied.
totalCount - Int!Total amount of uniq matching results.
Example
js
{
  "data": [Uniq],
  "pagination": Pagination,
  "totalCount": 123
}

Types

UniqMedias

Description

Each token and factory must have some visual representation added to it so it could be nicely displayed in the frontend.

Fields
Field NameDescription
gallery - [UniqResource!]!Here you provide a list of multiple media files. Not always would it make sense to have multiple images, but if this token is representing an in-game item then gallery images could be screenshots of this item in the game itself
hero - UniqResourceHero image is a big banner image that is typically placed in the top middle of the page. You can think of it as a movie poster buy applied to Uniq token.
product - UniqResource!This is a main media resource visually representing your token. If your token is a picture of an apple, then product media would be this picture by itself.
square - UniqResource!Square image is used whenever multiple tokens are shown on the same page, by providing a square image you make it easy to display your token by making its representation tileable.
Example
js
{
  "gallery": [UniqResource],
  "hero": UniqResource,
  "product": UniqResource,
  "square": UniqResource
}

Types

UniqMetadata

Description

Uniq metadata represent what this specific token is - it's name, description and attached media and data. When the token is issued, you can attach a URI of this Uniq metadata to the token and this way you would create a link between on-chain token and off-chain metadata. Example of what this metadata could represent can be an image from a collection of various other images and in this case you would put this image as one of the media fields and fill out the name and description to give some flavour to the token.

Fields
Field NameDescription
cachedSource - UniqResourceCopy of the source metadata inside ultra system. Optimized access to the metadata file, should be preferred over source field if provided. Null if not stored yet into ultra system.
content - UniqMetadataContentResolved content of the metadata file, ideal to display all metadata information about a uniq. Null if not resolved yet.
source - UniqResource!All information related to the source of the metadata information.
status - UniqMetadataStatus!Internal status of verification and caching metadata inside ultra system. Can be used to know if the metadata content is available/displayable.
Example
js
{
  "cachedSource": UniqResource,
  "content": UniqMetadataContent,
  "source": UniqResource,
  "status": "INVALID"
}

Types

UniqMetadataAttribute

Description

The UniqMetadataAttribute object represents a key value store describing attributes available for the uniq.

Fields
Field NameDescription
descriptor - UniqMetadataAttributeDescriptorDetails about the attribute.
key - String!Key that allow to retrieve the attribute.
value - JSONPrimitiveThe value of the attribute, the type can be determined thanks to the "descriptor" field.
Example
js
{
  "descriptor": UniqMetadataAttributeDescriptor,
  "key": "xyz789",
  "value": "true | \"myStringValue\" | 987 | 987.65"
}

Types

UniqMetadataAttributeDescriptor

Description

The UniqMetadataAttributeDescriptor allows you to specify structured numerical or string data for the factory.

Fields
Field NameDescription
description - StringDetails about what this attribute is.
dynamic - BooleanInformation flag to tag if the attribute is intended to change over time or not.
name - String!Title of the attribute
type - UniqMetadataAttributeType!Type of value expected. Can be used to know how to display the attribute. It can be boolean | number | string | ISODateString.
Example
js
{
  "description": "abc123",
  "dynamic": false,
  "name": "abc123",
  "type": "ISODateString"
}

Types

UniqMetadataAttributeType

Description

Primitive type of the attribute.

Values
Enum ValueDescription
ISODateStringDate primitive type.
booleanBoolean primitive type.
numberNumber primitive type.
stringString primitive type.
Example
js
"ISODateString"

Types

UniqMetadataContent

Description

The UniqMetadataContent object represents the content that follows the uniq metadata structure of the NFT standard.

Fields
Field NameDescription
attributes - [UniqMetadataAttribute!]Here you can specify a list of simple numerical or string attributes to go with the token. Allowed types for each of the attributes are: boolean, string and number
description - StringA detailed explanation about what this token is. The description could include some trivia or details about how it can be sued.
dynamicAttributes - UniqDynamicResourceThis field is represented as a single dynamic resource and it is used to provide a URI to an external resource detailing the content of dynamic attributes for this token.
dynamicResources - [UniqMetadataDynamicResource!]Allows additional dynamic media or reference data to be added as a part of the metadata. Each resource must be described as a dynamic resource.
medias - UniqMedias!Contains the media used to display this token. Refer to Metadata media for more details.
name - String!Name of this uniq. Used for identification purposes so best to make it distinguishable from other uniqs.
properties - JSONObjectAn arbitrary data that you can supply that does not fit any other category.
resources - [UniqMetadataResource!]Allows additional media or reference data to be added as a part of the metadata. Each resource must be described as a static resource.
subName - StringAn additional flavor name used to describe this Uniq token.
Example
js
{
  "attributes": [UniqMetadataAttribute],
  "description": "abc123",
  "dynamicAttributes": UniqDynamicResource,
  "dynamicResources": [UniqMetadataDynamicResource],
  "medias": UniqMedias,
  "name": "abc123",
  "properties": {"someProperty": "myStringValue", "otherProperty": 987},
  "resources": [UniqMetadataResource],
  "subName": "xyz789"
}

Types

UniqMetadataDynamicResource

Description

Allows additional dynamic media or reference data to be added as a part of the metadata. Each resource must be described as a dynamicResource.

Fields
Field NameDescription
key - String!Key that allow to retrieve the additional dynamic media.
value - UniqDynamicResource!The additional dynamic media data.
Example
js
{
  "key": "xyz789",
  "value": UniqDynamicResource
}

Types

UniqMetadataResource

Description

The UniqMetadataResource object allows additional media or reference data to be added as a part of the metadata. Each resource must be described as a staticResource.

Fields
Field NameDescription
key - String!Key that allow to retrieve the additional media.
value - UniqStaticResource!The additional media data.
Example
js
{
  "key": "xyz789",
  "value": UniqStaticResource
}

Types

UniqMetadataStatus

Description

Internal status of the metadata resolution.

Values
Enum ValueDescription
INVALIDMetadata resolution are in error, resources are misisng or metadata are not compliant, all informations about metadata are not or partially available.
PROCESSINGMetadata resolution is in progress inside ultra backend system.
VALIDMetadata resolution are done, all informations about metadata are compliant and available.
Example
js
"INVALID"

Types

UniqResale

Description

The UniqResale object represents information about the resale action.

Fields
Field NameDescription
onSaleDate - Date!Date of the resale.
price - MonetaryAmount!Selling price.
promoterBasisPoints - IntPromoter fees basis points. 1 means 0.0001, which means 0.01%
shares - [UniqSaleShare!]!A vector of [account, share] pairs setting the share each account receives during the token resale. Total limit to 7000 basis_point or 70%. The receiver can be duplicated.
Example
js
{
  "onSaleDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "price": MonetaryAmount,
  "promoterBasisPoints": 123,
  "shares": [UniqSaleShare]
}

Types

UniqResource

Description

The UniqResource object represents a resource, it's an image, video or a file.

Fields
Field NameDescription
contentType - StringType of resource image, video etc.
integrity - UniqResourceIntegrityInformation about the resource integrity.
uri - String!Uri where the resource is stored.
Example
js
{
  "contentType": "abc123",
  "integrity": UniqResourceIntegrity,
  "uri": "abc123"
}

Types

UniqResourceIntegrity

Description

The UniqResourceIntegrity object provides information about the integrity of the resource. Can be used to verify that the resource is the attended one.

Fields
Field NameDescription
hash - String!Hash related to the resource.
type - UniqResourceIntegrityType!Type of cryptographic hash.
Example
js
{"hash": "abc123", "type": "SHA256"}

Types

UniqResourceIntegrityType

Description

Type of cryptographic hash used.

Values
Enum ValueDescription
SHA256SHA256 encryption algorithm.
Example
js
"SHA256"

Types

UniqSaleShare

Description

The UniqSaleShare object represents a share commission on second hand market. It can be used to display details about commissions that will be applied when the uniq is sold.

Fields
Field NameDescription
basisPoints - Int!The resale commission. 1 means 0.0001, which means 0.01%
receiver - WalletId!WalletId receiving the share.
Example
js
{
  "basisPoints": 987,
  "receiver": "aa1aa2aa3ag4"
}

Types

UniqSerialRangeInput

Description

The UniqSerialRangeInput object represent a range of value. Can be used to filter uniqs by a range of serial number inside a factory.

Fields
Input FieldDescription
max - BigIntMaximum value of the range. If provided, it has to be greater or equal than min field. Null value means it will return all existing uniqs with a serial number greater or equal than min field.
min - BigInt!Minimum value of the range.
Example
js
{"max": 987, "min": 987}

Types

UniqSnapshot

Description

The Uniq Snapshot.

Fields
Field NameDescription
cursor - StreamCursorThe optional stream cursor to resume snapshots after.
id - BigInt!On chain id of the uniq.
position - StreamPosition!The stream position.
state - UniqStateThe optional state, null means deleted.
Example
js
{
  "cursor": "0",
  "id": 987,
  "position": "CURSOR",
  "state": UniqState
}

Types

UniqState

Description

The Uniq State object represents all information about a uniq in snapshot stream.

Fields
Field NameDescription
factory - UniqFactoryDigest!Information on factory related to this uniq.
id - BigInt!On chain id of the uniq.
metadata - UniqMetadata!Information on uniq metadata.
mintDate - Date!Date of uniq mint.
owner - WalletId!WalletId of the uniq owner.
resale - UniqResaleInformation about the uniq resale. Null means not on sale.
serialNumber - BigInt!Serial number of the uniq.
tradingPeriod - UniqTradingPeriodWindow time which trading actions are allowed. Null means not tradable
transferPeriod - UniqTransferPeriodWindow time which transfer actions are allowed. Null means not transferable
type - UniqType!Specify the type of the uniq asset.
Example
js
{
  "factory": UniqFactoryDigest,
  "id": 987,
  "metadata": UniqMetadata,
  "mintDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "owner": "aa1aa2aa3ag4",
  "resale": UniqResale,
  "serialNumber": 987,
  "tradingPeriod": UniqTradingPeriod,
  "transferPeriod": UniqTransferPeriod,
  "type": "COLLECTIBLE"
}

Types

UniqStaticResource

Description

The UniqStaticResource object represents a resource, it's an image, video or a file. Represented as a UniqResource with a hash specified.

Fields
Field NameDescription
contentType - String!Type of resource image,video etc.
integrity - UniqResourceIntegrity!Information about the resource integrity.
uri - String!Uri where the resource is stored.
Example
js
{
  "contentType": "xyz789",
  "integrity": UniqResourceIntegrity,
  "uri": "xyz789"
}

Types

UniqTradingPeriod

Description

The UniqTradingPeriod object represents a period of time when a uniq can be traded. [no start, no end], forever tradable. [no start, end], can only be traded before the ending date. [start, no end], can only be traded after the starting date. [start, end], can only be traded between the start and end dates.

Fields
Field NameDescription
duration - BigIntDuration of trading period, number of milliseconds. Ideal to display the remaining time before the period ends. Null means infinite duration.
endDate - DateThe ending of a time period when uniq can be traded. Null means no ending date to trade a uniq.
startDate - Date!The beginning of a time period when uniq can be traded.
Example
js
{
  "duration": 987,
  "endDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "startDate": "Thu Jul 13 2023 13:27:11 GMT+0200"
}

Types

UniqTransferPeriod

Description

The UniqTransferPeriod object represents a period of time when a uniq can be transferred. [no start, no end], forever transferable. [no start, end], can only be transferred before the ending date. [start, no end], can only be transferred after the starting date. [start, end], can only be transferred between the start and end dates.

Fields
Field NameDescription
duration - BigIntDuration of transfer period, number of milliseconds. Ideal to display the remaining time before the period ends. Null means infinite duration.
endDate - DateThe ending of a time period when uniq can be transferred. Null means no ending date to transfer a uniq.
startDate - Date!The beginning of a time period when uniq can be transferred.
Example
js
{
  "duration": 987,
  "endDate": "Thu Jul 13 2023 13:27:11 GMT+0200",
  "startDate": "Thu Jul 13 2023 13:27:11 GMT+0200"
}

Types

UniqType

Description

Specify the type of the uniq asset.

Values
Enum ValueDescription
COLLECTIBLEAsset available on the marketplace.
GAMEAsset of type Game.
Example
js
"COLLECTIBLE"

Types

WalletId

Description

A non empty string that represent a user wallet id.

Example
js
"aa1aa2aa3ag4"