Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of json format #259

Open
GuutBoy opened this issue Jan 26, 2024 · 1 comment
Open

Documentation of json format #259

GuutBoy opened this issue Jan 26, 2024 · 1 comment

Comments

@GuutBoy
Copy link

GuutBoy commented Jan 26, 2024

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
Copy link
Contributor

@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.

@smcclellan smcclellan moved this from 🆕 New to 📋 Backlog in Ordinals Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants