Hyype - Docs
AppTwitterBlog
Search…
Introduction to Hyy.pe
⚙
API Reference
API Introduction
Getting Started
NFT Object Model
NFT Lore Object Model
Canon Lore Object Model
GET Methods
POST Methods
Editor Lore Blocks
Lore React Component
✏
Collection Tools
Tools Introduction
Admin management
Set up a discord Lore bot
Set up a Writing Prompt
Custom Lore Tags
🪄
Tutorials
Sample Lore App
Create a Discord Webhook
🔗
Official Links
Supported Chains
App and Social
Brand Kit
Powered By GitBook
Getting Started
How to get started using Hyype API to integrate Lore with your own experiences
Good to know: This is a quick start guide for builders to jump right into using the APIs to get up and running in a few simple steps. For more detailed information on all the methods available, Check out the API Reference docs.

Get your API Key / Client ID

Important: Client ID is optional at the moment but will be required soon. please make sure to request yours if you are planning to use Hyype API in a production environment.

Make your request

To make a request, send your Client ID in the request header alongside required query parameters to the Lores API. On success, the API will return a list of all lore objects relevant to a particular requested NFT within your collection.
get
https://api.hyy.pe/api/v1
/lores
All Lores
Take a look at how you might want to pass on the client ID via HTTP or curl:
cURL
HTTP
curl --location --request GET 'http://api.hyy.pe/api/v1/lores?searchKey=0x700f045de43fce6d2c25df0288b41669b7566bbe-12' \
--header 'client-id: YOUR_CLIENT_ID_HERE' \
--data-raw ''
HTTP
GET /api/v1/lores?searchKey=0x700f045de43fce6d2c25df0288b41669b7566bbe-12 HTTP/1.1
Host: api.hyy.pe
client-id: YOUR_CLIENT_ID_HERE
Previous
How to get a Client ID
Next - API Reference
NFT Object Model
Last modified 3mo ago
Export as PDF
Copy link
On this page
Get your API Key / Client ID
Make your request
get
All Lores