{"id":13472398,"url":"https://github.com/CardanoSolutions/ogmios","last_synced_at":"2025-03-26T15:32:16.871Z","repository":{"id":36954674,"uuid":"247824456","full_name":"CardanoSolutions/ogmios","owner":"CardanoSolutions","description":"❇️ A WebSocket JSON/RPC bridge for Cardano","archived":false,"fork":false,"pushed_at":"2024-09-26T14:36:10.000Z","size":61550,"stargazers_count":304,"open_issues_count":3,"forks_count":90,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-10-23T01:22:41.895Z","etag":null,"topics":["cardano","cardano-node","javascript","json","websocket"],"latest_commit_sha":null,"homepage":"https://ogmios.dev","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CardanoSolutions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":"KtorZ"}},"created_at":"2020-03-16T21:58:59.000Z","updated_at":"2024-10-17T10:21:40.000Z","dependencies_parsed_at":"2024-02-02T14:44:11.602Z","dependency_job_id":"74737462-9ee7-4d66-ba57-c63ca90cf19e","html_url":"https://github.com/CardanoSolutions/ogmios","commit_stats":{"total_commits":1004,"total_committers":18,"mean_commits":55.77777777777778,"dds":0.1733067729083665,"last_synced_commit":"e6293f5c45684c0786df6c1b74cf0d7699df3e92"},"previous_names":[],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CardanoSolutions%2Fogmios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CardanoSolutions%2Fogmios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CardanoSolutions%2Fogmios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CardanoSolutions%2Fogmios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CardanoSolutions","download_url":"https://codeload.github.com/CardanoSolutions/ogmios/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222151630,"owners_count":16939423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cardano","cardano-node","javascript","json","websocket"],"created_at":"2024-07-31T16:00:54.367Z","updated_at":"2025-03-26T15:32:16.858Z","avatar_url":"https://github.com/CardanoSolutions.png","language":"Haskell","funding_links":["https://github.com/sponsors/KtorZ"],"categories":["Haskell"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href='https://github.com/cardanosolutions/ogmios/actions?query=workflow%3A\"Continuous Integration\"'\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/cardanosolutions/ogmios/continuous-integration.yaml?style=for-the-badge\u0026label=\u0026logo=GitHub%20Actions\u0026logoColor=FFFFFF\"/\u003e\u003c/a\u003e \u003ca href='https://github.com/cardanosolutions/ogmios/actions?query=workflow%3A\"User Guide\"'\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/cardanosolutions/ogmios/user-guide.yaml?style=for-the-badge\u0026label=\u0026logo=Hugo\u0026logoColor=FFFFFF\"/\u003e\u003c/a\u003e \u003ca href='https://github.com/cardanosolutions/ogmios/actions?query=workflow%3A\"Network Synchronization\"'\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/cardanosolutions/ogmios/network-synchronization.yaml?style=for-the-badge\u0026label=\u0026logoColor=FFFFFF\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAWCAYAAADafVyIAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AYht+mSv2pdLCDiEOG6mRBqoijVqEIFUKt0KqDyaV/0KQhSXFxFFwLDv4sVh1cnHV1cBUEwR8QNzcnRRcp8bu00CLGg7t7eO97X+6+A4R6mWlW1wSg6baZSsTFTHZVDLyiH70I0RqTmWXMSVISnuPrHj6+30V5lnfdn2NAzVkM8InEs8wwbeIN4ulN2+C8TxxmRVklPiceN+mCxI9cV5r8xrngssAzw2Y6NU8cJhYLHax0MCuaGvEUcUTVdMoXMk1WOW9x1spV1ronf2Ewp68sc53mCBJYxBIkiFBQRQll2IjSrpNiIUXncQ//sOuXyKWQqwRGjgVUoEF2/eB/8Lu3Vn4y1kwKxoHuF8f5GAUCu0Cj5jjfx47TOAH8z8CV3vZX6sDMJ+m1thY5AkLbwMV1W1P2gMsdYOjJkE3Zlfw0hXweeD+jb8oCg7dA31qzb61znD4AaepV8gY4OATGCpS97vHuns6+/VvT6t8PXGZynkY9QMIAAAAGYktHRAAAAAAAAPlDu38AAAAJcEhZcwAADdcAAA3XAUIom3gAAAAHdElNRQflCwkPDArHub8lAAACFUlEQVRIx6WVP2yOURTGf7c1oINEUk0HjVRKVBSlDSryaUqqExZzE0sl4m9FRAwkdgYxde5k8i8iRLSNIHRhkQ5qEEoTg/oi9Gdw37iaV99+n7O853nuuSfvee4950KOqXXqthz+ino5h+9Wl+blWkS+NQBdwJM5/DWgnBO/GXgNzFCJqWEBMbXzrdcUJJ9SBxOuS+1M8AXgA9WaekJdn+DP6mSCN6gDC012tihY7VX3FMQcT6tOJXoKjGfyqE3Rb1DvqqPAe2BaHVNvq/UxpkXNco0Cj4qquehv26ie948NqzcSfFrtiP6lSq7pA2AN8A54nvAvgVrgQMTjwAQwBNzJSxQKKjkCNMeSv4UQ7kd+N7AY6AHehhCuzpekP34b1Xvq2oj3J1LczNl3K1k/GLlW9bG6MuIzNUB9IlddlGDuBcirdDbxfyZcGfgR8VSRREeBVcBDoJxI1AMsAXYBEyGE65U22A51SF2u7k2kOBf7JbPeGDOslioZFfuAfmA10J7wW+NgS3ETcAjoLvrrTrUj+jVqS/RXxKYaU7eobepI5BpiTFM2GNXtandeH5SA78CzEMIs8AYghPAR6Iub+4CvIYSdf931ECYTuAlYFnup8CwG1LYEz6ivEtyqnvyfafopjuQMl9T2BA+q00VvQtWPSXZe1SRuzCtdXZdN2Tn8KbW5kmv6BXiRwx8DDufwI/962X4BWCfNDCIa+lYAAAAASUVORK5CYII=\"/\u003e\u003c/a\u003e\n\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"./branding/ogmios__light.png\"\u003e\n    \u003cimg alt=\"Ogmios: gateway to Cardano\" src=\"./branding/ogmios__dark.png\" width=\"240\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n**Ogmios** is a lightweight bridge interface for [cardano-node](https://github.com/intersectMBO/cardano-node/). It provides an **HTTP / WebSocket** API that enables applications to interact with a local cardano-node via **JSON+RPC-2.0**.\n\n## Compatibility\n\n| Ogmios        | Cardano-node (mainnet, preview, preprod) |\n| ---           | ---                                      |\n| **`v6.11.*`** | **`10.1.2`, `10.1.3`, `10.1.4`**         |\n| `v6.10.*`     | `10.1.2`, `10.1.3`, `10.1.4`             |\n| `v6.9.*`      | `10.1.2`, `10.1.3`                       |\n| `v6.8.*`      | `9.2.0`, `9.1.1`                         |\n| `v6.7.*`      | `9.2.0`, `9.1.1`                         |\n\n## QuickStart\n\nUsing [Homebrew](https://brew.sh/):\n\n```\nbrew tap CardanoSolutions/formulas\nbrew install ogmios\n```\n\nSee our [Ogmios client starter kit](https://github.com/CardanoSolutions/ogmios-ts-client-starter-kit#ogmios-client-starter-kit) or jump right into the [user manual](https://ogmios.dev).\n\n## Features\n\n\u003ctable align=\"center\"\u003e\n  \u003ctr\u003e\u003ctd\u003eFast synchronization of blocks from the Cardano network(s)\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/mini-protocols/local-chain-sync/\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n  \u003ctr\u003e\u003ctd\u003eTransaction submission with enhanced error messages\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/mini-protocols/local-tx-submission/#submittx\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n  \u003ctr\u003e\u003ctd\u003eEvaluation of Plutus script execution units\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/mini-protocols/local-tx-submission/#evaluatetx\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n  \u003ctr\u003e\u003ctd\u003eLocal mempool monitoring\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/mini-protocols/local-tx-monitor/\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n  \u003ctr\u003e\n  \u003ctd\u003e\n  State queries\u003cbr/\u003e\n  \u003cdetails\u003e\u003csummary\u003eNetwork\u003c/summary\u003e\n\n  queryNetwork                 | Information\n  ---                          | ---\n  `blockHeight`                | The chain's highest block number.\n  `genesisConfiguration`       | Get the genesis configuration of a specific era.\n  `startTime`                  | The chain's start time (UTC).\n  `tip`                        | The network's current tip.\n  \u003c/details\u003e\n  \u003cdetails\u003e\u003csummary\u003eLedger\u003c/summary\u003e\n\n  queryLedgerState             | Information\n  ---                          | ---\n  `constitution`               | The current on-chain constitution.\n  `constitutionalCommittee`    | A complete summary of the constitutional committee.\n  `delegateRepresentatives`    | A summary of registered (and pre-defined) delegate representatives, with their voting power.\n  `epoch`                      | The current epoch of the ledger.\n  `eraStart`                   | The information regarding the beginning of the current ledger era.\n  `eraSummaries`               | Era bounds and slot parameters details, required for proper slotting arithmetic.\n  `governanceProposals`        | Currently active governance proposals and their ratification state (i.e. votes).\n  `liveStakeDistribution`      | Distribution of the stake across all known stake pools, relative to the **total** stake in the network.\n  `projectedRewards`           | The projected rewards of an account in a context where the top stake pools are fully saturated. This projection gives, in principle, a ranking of stake pools that maximizes delegator rewards.\n  `protocolParameters`         | The current protocol parameters.\n  `proposedProtocolParameters` | The last update proposal w.r.t. protocol parameters, if any.\n  `rewardAccountSummaries`     | Current delegation settings and rewards of chosen reward accounts.\n  `rewardsProvenance`          | Get details about rewards calculation for the ongoing epoch.\n  `stakePools`                 | The list of all pool identifiers currently registered and active.\n  `tip`                        | The current tip the ledger is at. Said differently, the slot number and header hash of the last block that has been processed by the ledger.\n  `treasuryAndReserves`        | The Ada value of the treasury and reserves of the protocol.\n  `utxo`                       | Current UTXO, possibly filtered by output reference.\n  \u003c/details\u003e\n  \u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"https://ogmios.dev/mini-protocols/local-state-query/\" target=\"_blank\"\u003e↗️\u003c/a\u003e\n  \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\u003ctd\u003eDual WebSocket/HTTP support\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/getting-started/basics\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n  \u003ctr\u003e\u003ctd\u003eStructured JSON logging\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/getting-started/monitoring/\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n  \u003ctr\u003e\u003ctd\u003eHealth monitoring, with runtime and application statistics\u003c/td\u003e\u003ctd\u003e\u003ca href=\"https://ogmios.dev/getting-started/monitoring/\" target=\"_blank\"\u003e↗️\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003e [!TIP]\n\u003e\n\u003e Test vectors that cover every part of the protocol are [available here](https://github.com/CardanoSolutions/ogmios/tree/master/server/test/vectors). Use them without moderation for a smooth integration!\n\n# Roadmap\n\n### Cutting-edge work\n\nThe project keeps a [changelog 💾](./CHANGELOG.md) in which all past changes and _recent-but-not-yet-released_ changes can be seen. Changes in the changelog have been implemented and are available in latest builds from the `master` branch.\n\n### Planned work\n\nThe [github issues \u0026 milestones 🎯][milestones] list planned tasks that haven't been implemented but have reached enough maturity to be well-defined and scoped. Milestones have end-dates to give a broad estimate of when it is expected.\n\n### Future work\n\nFinally, [discussions 💡][discussions] contains ongoing discussions regarding the future of Ogmios, with design decisions still under consideration.\n\n## Clients / SDKs\n\nOgmios provides a language-agnostic API which can be implemented using any WebSocket or HTTP client. If you prefer using a SDK in your favorite language, see below the available clients (_maintained by the community_):\n\n\u003ctable align=\"center\"\u003e\u003cthead\u003e\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/typescript.png\" alt=\"Logo:TypeScript\"\u003e\u003cbr/\u003e\u003ca href=\"https://ogmios.dev/typescript/api/modules/_cardano_ogmios_client.html\"\u003e\u003cstrong\u003eTypeScript\u003c/strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/go.png\" alt=\"Logo:Go\"\u003e\u003cbr/\u003e\u003ca href=\"https://github.com/savaki/ogmigo/#readme\"\u003e\u003cstrong\u003eGo\u003c/strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/kotlin.png\" alt=\"Logo:Kotlin\"\u003e\u003cbr/\u003e\u003ca href=\"https://github.com/projectNEWM/kogmios#readme\"\u003e\u003cstrong\u003eKotlin\u003c/strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/java.png\" alt=\"Logo:Java\"\u003e\u003cbr/\u003e\u003ca href=\"https://github.com/adabox-aio/ogmios-java-client.git#readme\"\u003e\u003cstrong\u003eJava\u003c/strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/python.png\" alt=\"Logo:Python\"\u003e\u003cbr/\u003e\u003ca href=\"https://ogmios-python.readthedocs.io/en/latest/examples/index.html\"\u003e\u003cstrong\u003ePython\u003c/Strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/elixir.png\" alt=\"Logo:Python\"\u003e\u003cbr/\u003e\u003ca href=\"https://github.com/wowica/xogmios\"\u003e\u003cstrong\u003eElixir\u003c/Strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/cpp.png\" alt=\"Logo:C++\"\u003e\u003cbr/\u003e\u003ca href=\"https://gitlab.com/viperscience/libogmios\"\u003e\u003cstrong\u003eC++\u003c/Strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003cimg height=72 width=72 src=\".github/clients/csharp.png\" alt=\"Logo:CSharp\"\u003e\u003cbr/\u003e\u003ca href=\"https://github.com/ItsDaveB/OgmiosDotnet\"\u003e\u003cstrong\u003eC#\u003c/Strong\u003e\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\u003cthead\u003e\u003c/table\u003e\n\n## Sponsors\n\nA big thank to [all our sponsors 💖](https://github.com/CardanoSolutions#-sponsors).\n\n\u003chr/\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://cardanosolutions.github.io/ogmios\"\u003e:book: User Manual\u003c/a\u003e\n  |\n  \u003ca href=\"CONTRIBUTING.md\"\u003e:triangular_ruler: Contributing\u003c/a\u003e\n  |\n  \u003ca href=\"CHANGELOG.md\"\u003e:floppy_disk: Changelog\u003c/a\u003e\n  |\n  \u003ca href=\"https://discord.gg/zMr6EGvBpr\"\u003e\u003cimg src=\".github/discord.svg\" alt=\"Discord\"\u003eDiscord (#ogmios)\u003c/a\u003e\n  |\n  \u003ca href=\"https://twitter.com/_KtorZ_\"\u003e\u003cimg src=\".github/twitter.svg\" alt=\"Twitter\"\u003e Twitter (@_KtorZ_)\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Need more information? Have a look at the \u003ca href=\"https://ogmios.dev/faq/\" alt=\"F.A.Q\"\u003eFrequently Asked Questions\u003c/a\u003e.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/cardanosolutions/ogmios/blob/master/LICENSE\"\u003e\u003cimg src=\".github/license.svg\" alt=\"license=MPL-2.0\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n[discussions]: https://github.com/CardanoSolutions/ogmios/discussions/categories/ideas-feature-requests?discussions_q=sort%3Atop+category%3A%22Ideas+%2F+Feature+Requests%22\n[milestones]: https://github.com/CardanoSolutions/ogmios/milestones\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCardanoSolutions%2Fogmios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCardanoSolutions%2Fogmios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCardanoSolutions%2Fogmios/lists"}