Documentation for the Onchain Registry API.
/entries
and /featured
endpoints to display Onchain Registry entries on their own surfacestarget_url
fieldtarget_url
and creator_name
fieldsName | Type | Description |
---|---|---|
page | number | The page number (default 1) |
limit | number | The number of entries per page (default 10) |
category | array | The category or categories of the entries of interest (Options: Games, Social, Creators, Finance, Media) |
curation | string | The entry’s level of curation (Options: Featured, Curated, Community) |
Name | Type | Description |
---|---|---|
id | string | Unique entry ID |
category | string | The category of the entry (Options: Games, Social, Creators, Finance, Media) |
title | string | The title of the entry |
short_description | string | Short version of the entry description (max 30 char) |
full_description | string | Full version of the entry description (max 200 char) |
image_url | string | URL of the entry’s featured image |
target_url | string | URL for the entry’s desired user action |
cta_text | string | This is the type of user action for the entry (Options: Play, Mint, Buy, Trade, Explore) |
function_signature | string | The function signature associated with the desired user action on the entry’s contract |
contract_address | string | The contract address associated with the entry |
token_id | string | The token ID if this is an ERC-1155 |
token_amount | string | The price of the entry’s desired user action |
featured | boolean | A true or false based on whether the entry is actively featured |
creator_name | string | The name of the entry’s creator |
creator_image_url | string | The logo of the entry’s creator |
curation | string | The entry’s level of curation Options:
|
start_ts | string | The UTC timestamp that the entry is open to users |
expiration_ts | string | The UTC timestamp that the entry is no longer open to users |
updated_at | string || null | The UTC timestamp that the entry was last updated (null if the entry has not been updated since creation) |
created_at | string | The UTC timestamp that the entry was created |