Tokens API

These API endpoints are designed to obtain or modify info pertaining to tokens. It's very likely that a lot of the APIs you use end up being from this list.
Resources
Token Object
Field
Type
Description
tokenId
number
Kudos token identifier, same as the on-chain token ID.
headline
string
Headline of kudos provided by creator during token registration.
description
string
Description of kudos provided by creator during token registration. This will be an empty string (””) if no description was provided.
startDateTimestamp
number?
Start date of kudos in UTC timestamp format, provided by creator during token registration. This will be null if no start date was provided.
endDateTimestamp
number?
End date of kudos in UTC timestamp format, provided by creator during token registration. This will be null if no end date was provided.
links
string[]
List of links, part of token metadata.
communityId
string
Community identifier for Community object.
createdByAddress
string
Address that created the kudos token.
createdAtTimestamp
number
UTC timestamp of when the kudos token was registered by creator.
imageUrl
string
URL for token image.
claimUrl
string?
URL where an allowlisted user can go and claim the Kudos.

Note that the claimUrl will be null if the token is a Kudos with unspecified tokens to avoid token farmers.
claimabilityAttributes
Claimability Attributes
Object representing token claim methods. This is set by the creator during token registration.
customAttributes
CustomAttribute[]
A JSON array that dictates custom attributes that the user wishes to associate with the Kudos outside of the default fields above.
Claimability Attributes Object
Field
Type
Description
isSignatureRequired
boolean
Represents if a signature is required in order to claim the kudos token
isAllowlistRequired
boolean
Represents if checking claimee identifiers or address against an allowlist is required in order to claim the kudos token.
totalClaimCount
number?
Number of claims allowed for the token. null if allowlist is required (isAllowlistRequired = true) .
remainingClaimCount
number?
Number of claims left for the token. null if allowlist is required (isAllowlistRequired = true) .
expirationTimestamp
number?
Timestamp for when the claim for the Kudos token should expire (be invalidated). null if there is no expiration on the token claim period.
Custom Attribute Object
Field
Type
Description
fieldName
boolean
Name of the custom attribute’s field
type
string
The type of the custom attribute. Options are string, number, date, boolean
value
string
number
Token Owner Object
Field
Type
Description
walletAddress
boolean
Wallet address that claimed the kudos token.
mintedAt
boolean
Date when the token was minted to the wallet, in ISO format.

Field	Type	Description
tokenId	number	Kudos token identifier, same as the on-chain token ID.
headline	string	Headline of kudos provided by creator during token registration.
description	string	Description of kudos provided by creator during token registration. This will be an empty string (””) if no description was provided.
startDateTimestamp	number?	Start date of kudos in UTC timestamp format, provided by creator during token registration. This will be null if no start date was provided.
endDateTimestamp	number?	End date of kudos in UTC timestamp format, provided by creator during token registration. This will be null if no end date was provided.
links	string[]	List of links, part of token metadata.
communityId	string	Community identifier for Community object.
createdByAddress	string	Address that created the kudos token.
createdAtTimestamp	number	UTC timestamp of when the kudos token was registered by creator.
imageUrl	string	URL for token image.
claimUrl	string?	URL where an allowlisted user can go and claim the Kudos. Note that the claimUrl will be null if the token is a Kudos with unspecified tokens to avoid token farmers.
claimabilityAttributes	Claimability Attributes	Object representing token claim methods. This is set by the creator during token registration.
customAttributes	CustomAttribute[]	A JSON array that dictates custom attributes that the user wishes to associate with the Kudos outside of the default fields above.

Field	Type	Description
isSignatureRequired	boolean	Represents if a signature is required in order to claim the kudos token
isAllowlistRequired	boolean	Represents if checking claimee identifiers or address against an allowlist is required in order to claim the kudos token.
totalClaimCount	number?	Number of claims allowed for the token. null if allowlist is required (isAllowlistRequired = true) .
remainingClaimCount	number?	Number of claims left for the token. null if allowlist is required (isAllowlistRequired = true) .
expirationTimestamp	number?	Timestamp for when the claim for the Kudos token should expire (be invalidated). null if there is no expiration on the token claim period.

Field	Type	Description
fieldName	boolean	Name of the custom attribute’s field
type	string	The type of the custom attribute. Options are string, number, date, boolean
value	string	number

Field	Type	Description
walletAddress	boolean	Wallet address that claimed the kudos token.
mintedAt	boolean	Date when the token was minted to the wallet, in ISO format.

Last modified 3mo ago