Tokens

Tokenized securities and balances.

Tokens

Security token registered on the platform. Represents a tokenized financial instrument issued by an issuer.

Fields

Fields on the Token object.

FieldTypeDescription
idID!
tickerString!Unique stock-market-style symbol identifying this token.
bloombergTickerStringBloomberg-style ticker symbol, used for external data referencing.
isinStringInternational Securities Identification Number, if assigned.
performanceFloat!
Arguments: interval: TokenPerformanceInterval!
Relative price change over the requested interval, as a decimal fraction.
priceUint64!Current market price. Price in euro cents per token.
openPrimaryMarketPrimaryMarketCurrently open primary market offering for this token, if any.
primaryMarketsPrimaryMarketConnection!
Arguments: first: Int, last: Int, before: String, after: String
Paginated list of all primary market offerings for this token.
secondaryMarketSecondaryMarketActive secondary market for this token, if one exists.
issuerIssuer!Issuer that created and manages this token.
viewerBalanceUserTokenBalance!
Arguments: input: TokenViewerBalanceInput
Balance of the authenticated viewer for this token.
lockUpUint64!Amount of this token's supply that is locked up and cannot be transferred.
totalBalanceSupplyUint64!Total on-chain supply of this token across all holders, in base units.
marketCapitalizationUint64!Market capitalization in euro cents: total on-chain supply multiplied by the current price.
publicFloatUint64!Public float in euro cents: (total on-chain supply minus locked-up supply) multiplied by the current price.

Queries

Root queries that return or operate on this object.

token

Retrieve a single token by ID or ticker.

type Query {
  token(tokenInput: TokenInput!): Token!
}

Arguments

ArgumentTypeDescription
tokenInputTokenInput!

Returns

Token

tokens

Paginated list of tokens, optionally filtered by issuer or market type.

type Query {
  tokens(first: Int, last: Int, before: String, after: String, filters: TokenFilters): TokenConnection!
}

Arguments

ArgumentTypeDescription
firstInt
lastInt
beforeString
afterString
filtersTokenFilters

Returns

TokenConnection

Related types

Supporting objects, inputs, and enums used by this page.

Objects

TokenBalance

Type: object

Aggregated token balance for a portfolio view. Summarizes holdings, current value, and price for a single token across all accounts.

Fields
FieldTypeDescription
tokenIDID!Identifier of the token this balance refers to.
tokenToken!Token entity for this balance.
balanceSpecificTokenUint64!Number of tokens held.
specificTokenPriceUint64!Current unit price of the token. Price in euro cents per token.
totalTokenValueUint64!Total market value of the held tokens. Amount in euro cents.

TokenConnection

Type: object

Relay connection for paginated Token results.

Fields
FieldTypeDescription
edges[TokenEdge!]!
nodes[Token]!
pageInfoPageInfo!
totalCountInt!

TokenEdge

Type: object

Relay edge wrapping a Token node with its pagination cursor.

Fields
FieldTypeDescription
cursorString!
nodeToken!

Inputs

TokenFilters

Type: input

Filters for narrowing the tokens query results.

Fields
FieldTypeDescription
issuerMarketTypes[IssuerMarketType!]Restrict to tokens whose issuer operates in the given market types.
issuerIDIDRestrict to tokens issued by a specific issuer.

TokenInput

Type: input

Lookup input for retrieving a single token. Provide either id or ticker.

Fields
FieldTypeDescription
idIDToken identifier.
tickerStringUnique stock-market-style ticker symbol.

TokenViewerBalanceInput

Type: input

Input to retrieve the authenticated viewer's balance for this token.

Fields
FieldTypeDescription
realizedPnlRangeInputUserTokenBalanceRealizedPnlRangeInput

Enums

TokenPerformanceInterval

Type: enum

Time interval used to compute token price performance.

Values
ValueDescription
LAST_WEEK
LAST_MONTH
LAST_YEAR
ALL_TIME

TokenVisibility

Type: enum

Controls which tokens are returned based on their market status.

Values
ValueDescription
ACTIVEOnly tokens with an active market (open or incoming primary market, or secondary market).
ALLAll tokens regardless of market status. Requires issuer.update permission.