mirror of
https://github.com/placeholder-soft/web.git
synced 2026-04-29 03:15:28 +08:00
Registry updates (#664)
* Updated the Registry API content This commit updates the Registry API docs to reflect the most recent additions to the API and removes the beta flags * Added Registry API to the sidebar Added Registry API to the sidebar now that we are no longer in beta
This commit is contained in:
mbeutt-cb
@@ -2,16 +2,17 @@
|
||||
title: Onchain Registry API
|
||||
slug: /tools/registry-api
|
||||
description: Documentation for the Onchain Registry API.
|
||||
keywords: [onchain registry, registry API, onchain API, Base registry, Base, Base apps, Base API]
|
||||
hide_table_of_contents: true
|
||||
---
|
||||
|
||||
# [Beta] Onchain Registry API
|
||||
# Onchain Registry API
|
||||
|
||||
---
|
||||
|
||||
:::info
|
||||
|
||||
The base url for our API endpoints is [https://base.org/api/registry/](https://base.org/api/registry/). Please note, this API is still in beta and should not be used in production environments. The use of Onchain Registry API is governed by the license terms outlined in our [Terms & Conditions](#terms--conditions).
|
||||
The base url for our API endpoints is [https://base.org/api/registry/](https://base.org/api/registry/). The use of Onchain Registry API is governed by the license terms outlined in our [Terms & Conditions](#terms--conditions).
|
||||
|
||||
:::
|
||||
|
||||
@@ -54,10 +55,15 @@ This endpoint will display all Onchain Registry entries subject to any query par
|
||||
"contract_address": "0x1FC10ef15E041C5D3C54042e52EB0C54CB9b710c",
|
||||
"token_id": "2",
|
||||
"token_amount": "0.01",
|
||||
"curation": "featured",
|
||||
"featured": true,
|
||||
"creator_name": "Base",
|
||||
"creator_image_url": "https://base.org/creator-image.png"
|
||||
}
|
||||
"creator_image_url": "https://base.org/creator-image.png",
|
||||
"curation": "featured",
|
||||
"start_ts": "2024-06-25T04:00:00Z",
|
||||
"expiration_ts": "2024-07-29T00:00:00Z"
|
||||
},
|
||||
"updated_at": null,
|
||||
"created_at": "2024-07-10T18:20:42.000Z"
|
||||
},
|
||||
{
|
||||
"id": "8fRbdN8uf601fCkH1e084F",
|
||||
@@ -73,10 +79,15 @@ This endpoint will display all Onchain Registry entries subject to any query par
|
||||
"contract_address": "0x1FC10ef15E041C5D3C54042e52EB0C54CB9b710c",
|
||||
"token_id": "1",
|
||||
"token_amount": "0.005",
|
||||
"curation": "community",
|
||||
"featured": false,
|
||||
"creator_name": "Base",
|
||||
"creator_image_url": "https://base.org/creator-image2.png"
|
||||
}
|
||||
"creator_image_url": "https://base.org/creator-image2.png",
|
||||
"curation": "community",
|
||||
"start_ts": "2024-06-25T04:00:00Z",
|
||||
"expiration_ts": "2024-07-29T00:00:00Z"
|
||||
},
|
||||
"updated_at": "2024-07-11T18:20:42.000Z",
|
||||
"created_at": "2024-07-10T18:20:42.000Z"
|
||||
}
|
||||
],
|
||||
"pagination": {
|
||||
@@ -109,33 +120,43 @@ This endpoint will display a single Onchain Registry entry that is being activel
|
||||
"contract_address": "0x1FC10ef15E041C5D3C54042e52EB0C54CB9b710c",
|
||||
"token_id": "2",
|
||||
"token_amount": "0.01",
|
||||
"curation": "featured",
|
||||
"featured": true,
|
||||
"creator_name": "Base",
|
||||
"creator_image_url": "https://base.org/creator-image.png"
|
||||
}
|
||||
"creator_image_url": "https://base.org/creator-image.png",
|
||||
"curation": "featured",
|
||||
"start_ts": "2024-06-25T04:00:00Z",
|
||||
"expiration_ts": "2024-07-29T00:00:00Z"
|
||||
},
|
||||
"updated_at": null,
|
||||
"created_at": "2024-07-10T18:20:42.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Entry Schema
|
||||
|
||||
| Name | Type | Description |
|
||||
| :----------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| id | string | Unique entry ID |
|
||||
| category | string | The category of the entry <br/>(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 <br/> (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 |
|
||||
| curation | string | The entry’s level of curation <br/> <br/> Options: <ul><li>Featured - one entry per day with top placement</li><li>Curated - community entries being</li><li>Community - all other community entries</li></ul> |
|
||||
| creator_name | string | The name of the entry’s creator |
|
||||
| creator_image_url | string | The logo of the entry’s creator |
|
||||
| Name | Type | Description |
|
||||
| :----------------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| id | string | Unique entry ID |
|
||||
| category | string | The category of the entry <br/>(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 <br/> (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 <br/> <br/> Options: <ul><li>Featured - one entry per day with top placement</li><li>Curated - community entries being</li><li>Community - all other community entries</li></ul> |
|
||||
| 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 |
|
||||
|
||||
## Terms & Conditions
|
||||
|
||||
|
||||
@@ -42,6 +42,7 @@ module.exports = {
|
||||
'tools/onramps',
|
||||
'tools/onboarding',
|
||||
'tools/bridges-mainnet',
|
||||
'tools/registry-api',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Toolchains',
|
||||
|
||||
Reference in New Issue
Block a user