{"id":25825629,"url":"https://github.com/anotherrusty/btc-ord-apis","last_synced_at":"2026-06-10T12:31:26.677Z","repository":{"id":242418887,"uuid":"807608018","full_name":"AnotherRusty/Btc-Ord-APIs","owner":"AnotherRusty","description":"Features: Inscription endpoints, BRC-20 endpoints, Satosh Ordinal notation endpoints, Run modes for auto-scaling","archived":false,"fork":false,"pushed_at":"2024-06-02T21:04:19.000Z","size":111,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-28T19:13:07.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnotherRusty.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-29T12:31:56.000Z","updated_at":"2024-10-18T06:20:01.000Z","dependencies_parsed_at":"2024-06-02T22:32:35.105Z","dependency_job_id":"001d1016-005a-4b5c-a30d-e38eb1bde3e9","html_url":"https://github.com/AnotherRusty/Btc-Ord-APIs","commit_stats":null,"previous_names":["rusty015/bbgo-finance","anotherrusty/btc-ord-apis"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AnotherRusty/Btc-Ord-APIs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnotherRusty%2FBtc-Ord-APIs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnotherRusty%2FBtc-Ord-APIs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnotherRusty%2FBtc-Ord-APIs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnotherRusty%2FBtc-Ord-APIs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnotherRusty","download_url":"https://codeload.github.com/AnotherRusty/Btc-Ord-APIs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnotherRusty%2FBtc-Ord-APIs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34153482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-28T14:06:30.329Z","updated_at":"2026-06-10T12:31:26.655Z","avatar_url":"https://github.com/AnotherRusty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n       /     /   ▶ Ordinals API   \n      / --- /      A service that ingests Bitcoin ordinal inscriptions to expose them via REST API endpoints.\n     /     /       \n\n* [Features](#features)\n* [API Reference](#api-reference)\n* [Quick Start](#quick-start)\n    * [System Requirements](#system-requirements)\n    * [Running the API](#running-the-api)\n    * [Run Modes](#run-modes)\n    * [Stopping the API](#stopping-the-api)\n* [Bugs and Feature Requests](#bugs-and-feature-requests)\n* [Contribute](#contribute)\n* [Community](#community)\n\n***\n\n# Features\n\n* Inscription endpoints\n    * Genesis block and transaction information\n    * Transfer history\n    * Transfers per block\n    * Current location and ownership information\n    * Blessed and cursed inscriptions\n* BRC-20 endpoints\n    * Full token deploy, mint and transfer history\n    * Activities per token and per address\n    * Address balances\n* Satoshi ordinal notation endpoints\n* ETag cache support\n* Run modes for auto-scaling\n\n# API Reference\n\nSee the [Ordinals API Reference](https://docs.hiro.so/ordinals/) for more\ninformation.\n\n# Quick Start\n\n## System Requirements\n\nThe Ordinals API has hard dependencies on other systems.\nBefore you start, you'll need to have access to:\n\n1. An [Ordhook node](https://github.com/hirosystems/ordhook) with a fully\n   indexed Ordinals database.\n1. A local writeable Postgres database for data storage\n\n## Running the API\n\n1. Clone the repo.\n\n1. Create an `.env` file and specify the appropriate values to configure the local\nAPI server, postgres DB and Ordhook node reachability. See\n[`env.ts`](https://github.com/hirosystems/ordinals-api/blob/develop/src/env.ts)\nfor all available configuration options.\n\n1. Build the app (NodeJS v18+ is required)\n    ```\n    npm install\n    npm run build\n    ```\n\n1. Start the service\n    ```\n    npm run start\n    ```\n\n### Run Modes\n\nTo better support auto-scaling server configurations, this service supports\nthree run modes specified by the `RUN_MODE` environment variable:\n\n* `default`: Runs all background jobs and the API server. Use this when you're\n  running this service only on one instance. This is the default mode.\n* `readonly`: Runs only the API server. Use this in an auto-scaled cluster when\n  you have multiple `readonly` instances and just one `writeonly` instance. This\n  mode needs a `writeonly` instance to continue populating the DB.\n* `writeonly`: Use one of these in an auto-scaled environment so you can\n  continue consuming new inscriptions. Use in conjunction with multiple\n  `readonly` instances as explained above.\n\n### Stopping the API\n\nWhen shutting down, you should always prefer to send the `SIGINT` signal instead\nof `SIGKILL` so the service has time to finish any pending background work and\nall dependencies are gracefully disconnected.\n\n# Bugs and feature requests\n\nIf you encounter a bug or have a feature request, we encourage you to follow the\nsteps below:\n\n 1. **Search for existing issues:** Before submitting a new issue, please search\n    [existing and closed issues](../../issues) to check if a similar problem or\n    feature request has already been reported.\n 1. **Open a new issue:** If it hasn't been addressed, please [open a new\n    issue](../../issues/new/choose). Choose the appropriate issue template and\n    provide as much detail as possible, including steps to reproduce the bug or\n    a clear description of the requested feature.\n 1. **Evaluation SLA:** Our team reads and evaluates all the issues and pull\n    requests. We are avaliable Monday to Friday and we make a best effort to\n    respond within 7 business days.\n\nPlease **do not** use the issue tracker for personal support requests or to ask\nfor the status of a transaction. You'll find help at the [#support Discord\nchannel](https://discord.gg/SK3DxdsP).\n\n\n# Contribute\n\nDevelopment of this product happens in the open on GitHub, and we are grateful\nto the community for contributing bugfixes and improvements. Read below to learn\nhow you can take part in improving the product.\n\n## Code of Conduct\nPlease read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md)\nsince we expect project participants to adhere to it. \n\n## Contributing Guide\nRead our [contributing guide](.github/CONTRIBUTING.md) to learn about our\ndevelopment process, how to propose bugfixes and improvements, and how to build\nand test your changes.\n\n# Community\n\nJoin our community and stay connected with the latest updates and discussions:\n\n- [Join our Discord community chat](https://discord.gg/ZQR6cyZC) to engage with\n  other users, ask questions, and participate in discussions.\n\n- [Visit hiro.so](https://www.hiro.so/) for updates and subcribing to the\n  mailing list.\n\n- Follow [Hiro on Twitter.](https://twitter.com/hirosystems)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanotherrusty%2Fbtc-ord-apis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanotherrusty%2Fbtc-ord-apis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanotherrusty%2Fbtc-ord-apis/lists"}