Ocelloids Services Quickstart

To install dependencies, run:

bun install

To run the application, execute:

bun run index.ts

Examples

You can find usage examples in the examples/ folder of this repository.

To run an example, execute:

OC_API_KEY=<YOUR_API_KEY> bun run examples/steward/assets-metadata.ts

Replace YOUR_API_KEY with your Ocelloids API key. If you don't have one yet, you can use our read-only key for testing:

https://www.ocelloids.net/docs/api-key/

Alternatively, you can create a .env file in the project root directory to store the API key:

# .env file
OC_API_KEY=<YOUR_API_KEY>

After setting up your API key, you can execute any example by running:

bun run examples/steward/assets-metadata.ts