Communities API

API endpoint designed to return information pertaining to communities.

Resources

Community Object

​
Field
Type
Description
uniqId
string
The unique identifier of the community that the Kudos token belongs to.
displayId
string
The displayId of the community. Used in community page URLs for now.
name
string
Name of the community.
description
string
Description of the community
logoUrl
string
URL of the community logo asset

Community 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.
assetUrl
string
The URL of the Kudos asset
createdAtTimestamp
string
UTC timestamp of when the kudos token was registered by creator.
customAttributes
CustomAttributeObject[]
A JSON array that dictates custom attributes that the user wishes to associate with the Kudos outside of the default fields above.

NFT Type Object

Because a Kudos token is based on the ERC1155 standard, every token has some visual representation, usually in the form of an image or a video. An NFT type describes the properties of a particular display asset that can be associated with a Kudos token on creation of the token.
Field
Type
Description
name
string
Name of the NFT type. Is unique to the community that the NFT type belongs to.
nftTypeId
string
ID of the NFT type. Is globally unique.
previewAssetUrl
string
URL where the asset of the NFT type is stored.
isUserAdded
boolean
Flag to indicate whether the NFT type was added by a user or by the system.
hasTextOverlay
boolean
Boolean to indicate that there should be text overlay of the headline when the NFT image is uploaded. Example NFT image with an overlay looks like this: https://images.mintkudos.xyz/nft/default/greenPurplePreview.png |