Comment on page

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.
All Lores
Take a look at how you might want to pass on the client ID via HTTP or curl:
curl --location --request GET '' \
--header 'client-id: YOUR_CLIENT_ID_HERE' \
--data-raw ''
GET /api/v1/lores?searchKey=0x700f045de43fce6d2c25df0288b41669b7566bbe-12 HTTP/1.1