Getting Started

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 Client ID
Client ID is equivalent to an API key which helps us identify and provide production-grade throughput for your demand and experiences. Any request that doesn't include a client ID (optional at the moment) will start returning an error.
You can request a client ID by writing to us at [email protected] or reaching out to us on our discord / twitter.
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
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.
Take a look at how you might want to pass on the client ID via HTTP or curl:
cURL
HTTP
1
curl --location --request GET 'http://api.hyy.pe/api/v1/lores?searchKey=0x700f045de43fce6d2c25df0288b41669b7566bbe-12' \
2
--header 'client-id: YOUR_CLIENT_ID_HERE' \
3
--data-raw '' 
Copied!
1
HTTP
2
GET /api/v1/lores?searchKey=0x700f045de43fce6d2c25df0288b41669b7566bbe-12 HTTP/1.1
3
Host: api.hyy.pe
4
client-id: YOUR_CLIENT_ID_HERE
Copied!

Introduction to Hyy.pe

Next - API Reference

API Introduction

Last modified 2mo ago

Export as PDF

Copy link

Contents