hirosystems / ordhook

Build indexers, standards and protocols on top of Ordinals and Inscriptions (BRC20, etc).
Apache License 2.0
180 stars 55 forks source link

Documentation of json format #259

Open GuutBoy opened 7 months ago

GuutBoy commented 7 months ago

When running something like

ordhook scan blocks --interval 767430:767753 --post-to=http://localhost:3000/api/events --config-path=./Ordhook.toml

Ordhook will post json objects to http://localhost:3000/api/events. However, I cant find any documentation for the schema used. Where should I look to understand the format?

smcclellan commented 7 months ago

@GuutBoy If you install the chainhook client here, you will get auto-completion & documentation for what gets returned.

Separately, I believe it would be helpful if we added an example to this page. That will be the scope of this ticket.

An example for that documentation is here.