Skip to main content

EmojiIDApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
editEmojiIDPATCH /emoji_id/{emoji_id}Edit EmojiIdemojiIDMetadata

editEmojiID#

Edit EmojiId

kotlin.Any editEmojiID(emojiId, body)#

Add and remove records in EmojiId, update merkle_root and signature too. Certain tags, such as `CryptocurrenyAddress`, `EmojiNick`, `EmojiDescription`, `EmojiPreferred`, `Redirect` only allow a single value to be stored by default. Only the latest values will be stored and older values deleted. To allow multiple values for the same tag pass in `true` for `bypass_single_restrictions` Access notes: user expected to own the emoji's pubkey, have Admin role or be power member of organization if pubkey belongs to organization, otherwise operation will fail.

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String
bodyEditRequest

Return type#

kotlin.Any

Authorization#

Configure apiKey: ApiClient.apiKey["Authorization,X-Api-Key"] = "" ApiClient.apiKeyPrefix["Authorization,X-Api-Key"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String |     val body : EditRequest =  // EditRequest | try {val result : kotlin.Any = apiInstance.editEmojiID(emojiId, body)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#editEmojiID")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#editEmojiID")e.printStackTrace()}

emojiIDMetadata#

ShapeMatch emojiIDMetadata(emojiId)#

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String

Return type#

ShapeMatch

Authorization#

No authorization required

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String | try {val result : ShapeMatch = apiInstance.emojiIDMetadata(emojiId)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#emojiIDMetadata")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#emojiIDMetadata")e.printStackTrace()}

generateSignature#

Generates a signature for the Yat allowing it to be minted

SignatureResponse generateSignature(emojiId, body)#

If the yat has any active transfers for it or is in the pending transfer period this action fails

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String
bodySignatureRequest

Return type#

SignatureResponse

Authorization#

Configure two_factor: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String |     val body : SignatureRequest =  // SignatureRequest | try {val result : SignatureResponse = apiInstance.generateSignature(emojiId, body)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#generateSignature")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#generateSignature")e.printStackTrace()}

getStats#

Get statistics for EmojiId

EmojiStatsResponse getStats(eid)#

Parameters#

NameTypeDescriptionNotes
eidkotlin.String

Return type#

EmojiStatsResponse

Authorization#

Configure apiKey: ApiClient.apiKey["Authorization,X-Api-Key"] = "" ApiClient.apiKeyPrefix["Authorization,X-Api-Key"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val eid : kotlin.String = eid_example // kotlin.String | try {val result : EmojiStatsResponse = apiInstance.getStats(eid)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#getStats")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#getStats")e.printStackTrace()}

linkRedirect#

Redirect by EmojiId link

linkRedirect(emojiId, link)#

Will redirect to a link if it is part of Emoji ID

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String
linkkotlin.String

Return type#

null (empty response body)

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: Not defined

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String |     val link : kotlin.String = link_example // kotlin.String | try {apiInstance.linkRedirect(emojiId, link)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#linkRedirect")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#linkRedirect")e.printStackTrace()}

listEmojiIDs#

List user's Emoji Ids

kotlin.collections.List<kotlin.String> listEmojiIDs(organizationId, userId)#

If no parameters provided will return all Emoji Ids of current user. When `user_id` or `organization_id` specified the endpoint will return the Emoji Ids owned by specified user or organization, requires Admin or organization power user access. Result is an array of emoji ids in display format (i.e. with all skin tone modifiers applied) `[\"🤟🏾🍗👽👻\",\"🌈👍🏿💯\"]`

Parameters#

NameTypeDescriptionNotes
organizationIdjava.util.UUIDLookup emojis owned by `organization_id`, requires organization power user role[optional]
userIdjava.util.UUIDLookup emojis owned by `user_id`, requires Admin role[optional]

Return type#

kotlin.collections.List<kotlin.String>

Authorization#

Configure apiKey: ApiClient.apiKey["Authorization,X-Api-Key"] = "" ApiClient.apiKeyPrefix["Authorization,X-Api-Key"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val organizationId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Lookup emojis owned by `organization_id`,  requires organization power user role    val userId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Lookup emojis owned by `user_id`,  requires Admin roletry {val result : kotlin.collections.List<kotlin.String> = apiInstance.listEmojiIDs(organizationId, userId)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#listEmojiIDs")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#listEmojiIDs")e.printStackTrace()}

listExtended#

List extended view user's Emoji Ids

kotlin.collections.List<EmojiListItem> listExtended(organizationId, userId)#

Will return list of user's Emoji Ids with canonical and display representation. Display representation is Emoji Id with applied modifiers. If no parameters provided will return all Emoji Ids of the current user. When `user_id` or `organization_id` is specified the endpoint will return the Emoji Ids owned by the specified user or organization, requires Admin or organization power user access.

Parameters#

NameTypeDescriptionNotes
organizationIdjava.util.UUIDLookup emojis owned by `organization_id`, requires organization power user role[optional]
userIdjava.util.UUIDLookup emojis owned by `user_id`, requires Admin role[optional]

Return type#

kotlin.collections.List<EmojiListItem>

Authorization#

Configure apiKey: ApiClient.apiKey["Authorization,X-Api-Key"] = "" ApiClient.apiKeyPrefix["Authorization,X-Api-Key"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val organizationId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Lookup emojis owned by `organization_id`,  requires organization power user role    val userId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Lookup emojis owned by `user_id`,  requires Admin roletry {val result : kotlin.collections.List<EmojiListItem> = apiInstance.listExtended(organizationId, userId)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#listExtended")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#listExtended")e.printStackTrace()}

loadJson#

Load value from EmojiId key value store

LoadJsonResponse loadJson(eid, key)#

Any data stored previously can be retrieved as a json object in EmojiID key value store. In the case when there was no data associated with EmojiID key before it will return empty object. User should have `AdminEmojiWrite` scope or own emoji

Parameters#

NameTypeDescriptionNotes
eidkotlin.StringEmojiID
keykotlin.StringKey to store data[enum: YatPageData, YatLinkData, VisualizerData, VisualizerName, VisualizerFileLocations]

Return type#

LoadJsonResponse

Authorization#

No authorization required

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val eid : kotlin.String = eid_example // kotlin.String | EmojiID    val key : kotlin.String = key_example // kotlin.String | Key to store datatry {val result : LoadJsonResponse = apiInstance.loadJson(eid, key)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#loadJson")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#loadJson")e.printStackTrace()}

loadJsonIndex#

Load value from EmojiId key value store with data keyed by YatJsonStoreKeys

kotlin.collections.Map<kotlin.String, LoadJsonResponse> loadJsonIndex(eid, keys)#

Any data stored previously can be retrieved as a json object in EmojiID key value store. In the case when there was no data associated with EmojiID key before it will return empty object. User should have `AdminEmojiWrite` scope or own emoji

Parameters#

NameTypeDescriptionNotes
eidkotlin.String
keyskotlin.collections.List<kotlin.String>Key to store data

Return type#

kotlin.collections.Map<kotlin.String, LoadJsonResponse>

Authorization#

No authorization required

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val eid : kotlin.String = eid_example // kotlin.String |     val keys : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | Key to store datatry {val result : kotlin.collections.Map<kotlin.String, LoadJsonResponse> = apiInstance.loadJsonIndex(eid, keys)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#loadJsonIndex")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#loadJsonIndex")e.printStackTrace()}

lookupEmojiID#

Lookup EmojiId

LookupResponse lookupEmojiID(emojiId, tags)#

Will filter and return data from supplied tags, If tags filter is not supplied will return all tags attached. It will also try to get views for the past month, if not available will return -1. This method is called when a user wants to look up an Emoji ID's records such as a crypto address or a redirect

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String
tagskotlin.StringComma-separated list of tags to display, skip it to display all, e.g. `?tags=0x0001,0x1001`[optional]

Return type#

LookupResponse

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String |     val tags : kotlin.String = tags_example // kotlin.String | Comma-separated list of tags to display, skip it to display all, e.g. `?tags=0x0001,0x1001`try {val result : LookupResponse = apiInstance.lookupEmojiID(emojiId, tags)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#lookupEmojiID")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#lookupEmojiID")e.printStackTrace()}

lookupEmojiIDPayment#

Lookup EmojiId Payment addresses

PaymentAddressResponse lookupEmojiIDPayment(emojiId, tags)#

Will filter and return data from supplied tags, If tags filter is not supplied will return all payment tags attached. This method is called when a user wants to look up an Emoji ID's payment records and return a KV pair This endpoint returns a single result for each category type (except 0x6300) which it returns a unique 0x6300:short_name:settlement_network key instead. If there are multiple results for a crypto type it takes the most recent value unless there is a value that has the default flag set, in which case it uses the most recent default value.

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String
tagskotlin.StringComma-separated list of tags to display, skip it to display all, e.g. `?tags=0x0001,0x1001`[optional]

Return type#

PaymentAddressResponse

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String |     val tags : kotlin.String = tags_example // kotlin.String | Comma-separated list of tags to display, skip it to display all, e.g. `?tags=0x0001,0x1001`try {val result : PaymentAddressResponse = apiInstance.lookupEmojiIDPayment(emojiId, tags)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#lookupEmojiIDPayment")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#lookupEmojiIDPayment")e.printStackTrace()}

lookupEmojiIdTicker#

Lookup EmojiId data based on a symbol or ticker

EidResponse lookupEmojiIdTicker(emojiId, tag)#

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String
tagkotlin.String

Return type#

EidResponse

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String |     val tag : kotlin.String = tag_example // kotlin.String | try {val result : EidResponse = apiInstance.lookupEmojiIdTicker(emojiId, tag)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#lookupEmojiIdTicker")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#lookupEmojiIdTicker")e.printStackTrace()}

metadata#

Metadata metadata(tokenId)#

Parameters#

NameTypeDescriptionNotes
tokenIdkotlin.Long

Return type#

Metadata

Authorization#

No authorization required

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val tokenId : kotlin.Long = 789 // kotlin.Long | try {val result : Metadata = apiInstance.metadata(tokenId)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#metadata")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#metadata")e.printStackTrace()}

random#

Return random Emoji

RandomResult random()#

Returns price, availability and other information for random emoji

Parameters#

This endpoint does not need any parameter.

Return type#

RandomResult

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()try {val result : RandomResult = apiInstance.random()    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#random")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#random")e.printStackTrace()}

recent#

Return list of recently purchased emoji

RecentlyPurchasedResult recent()#

Parameters#

This endpoint does not need any parameter.

Return type#

RecentlyPurchasedResult

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()try {val result : RecentlyPurchasedResult = apiInstance.recent()    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#recent")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#recent")e.printStackTrace()}

rhythm#

Calculate EmojiId rhythm score

RhythmResponse rhythm(emojiId)#

The rhythm score is an indicator of a Yat's prestige, or status. Factors that affect the rhythm are length, shape, and the popularity of emojis present in the yat. The yat rhythm ranges from 1 (least prestigious) to 100 (most prestigious).

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.String

Return type#

RhythmResponse

Authorization#

No authorization required

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String | try {val result : RhythmResponse = apiInstance.rhythm(emojiId)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#rhythm")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#rhythm")e.printStackTrace()}

searchEmojiID#

Search for EmojiID

SearchResult searchEmojiID(emojiId)#

Returns price, availability and other information on emoji and its alternates (similar EmojiIDs that are currently available)

Parameters#

NameTypeDescriptionNotes
emojiIdkotlin.StringEmoji ID in percent url-encoded form

Return type#

SearchResult

Authorization#

Configure JWT: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val emojiId : kotlin.String = emojiId_example // kotlin.String | Emoji ID in percent url-encoded formtry {val result : SearchResult = apiInstance.searchEmojiID(emojiId)    println(result)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#searchEmojiID")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#searchEmojiID")e.printStackTrace()}

storeJson#

Store value under EmojiId key

storeJson(eid, key, body)#

Any data can be stored as a json object, this data is stored in a centralized DB and is not taking blockchain storage. In addition to unformatted data this endpoint allows to edit tags in the same way as edit endpoint allows to. User should have `AdminEmojiWrite` scope or own emoji

Parameters#

NameTypeDescriptionNotes
eidkotlin.StringEmojiID
keykotlin.StringKey to store data[enum: YatPageData, YatLinkData, VisualizerData, VisualizerName, VisualizerFileLocations]
bodyStoreJsonBody

Return type#

null (empty response body)

Authorization#

Configure apiKey: ApiClient.apiKey["Authorization,X-Api-Key"] = "" ApiClient.apiKeyPrefix["Authorization,X-Api-Key"] = ""

HTTP request headers#

  • Content-Type: Not defined
  • Accept: Not defined

Example#

// Import classes:// import com.yatlabs.yat.infrastructure.*// import com.yatlabs.yat.models.*
val apiInstance = EmojiIDApi()    val eid : kotlin.String = eid_example // kotlin.String | EmojiID    val key : kotlin.String = key_example // kotlin.String | Key to store data    val body : StoreJsonBody =  // StoreJsonBody | try {apiInstance.storeJson(eid, key, body)} catch (e: ClientException) {println("4xx response calling EmojiIDApi#storeJson")e.printStackTrace()} catch (e: ServerException) {println("5xx response calling EmojiIDApi#storeJson")e.printStackTrace()}