Horizon is the client facing API server for the Stellar ecosystem. It acts as the interface between Stellar Core and applications that want to access the Stellar network. It allows you to submit transactions to the network, check the status of accounts, subscribe to event streams and more.
Check out the following resources to get started:
- Horizon Development Guide: Instructions for building and developing Horizon. Covers setup, building, testing, and contributing. Also contains some helpful notes and context for Horizon developers.
- Quickstart Guide: An external tool provided from a separate repository. It builds a docker image which can be used for running the stellar stack including Horizon locally for evaluation and testing situations. A great way to observe a reference runtime deployment, to see how everything fits together.
- Horizon Testing Guide: Details on how to test Horizon, including unit tests, integration tests, and end-to-end tests.
If you're an administrator planning to run a production instance of Horizon as part of the public Stellar network, you should check out the instructions on our public developer docs - Run an API Server. It covers installation, monitoring, error scenarios and more.
- Supported on the two latest major Go releases
- Uses Go Modules for dependency management (see go.mod)
- Standard go build, go test, and go run workflows apply
Contributions are welcome! See CONTRIBUTING.md for more details.
The Development Guide will show you how to build Horizon, see what's going on behind the scenes, and set up an effective develop-test-push cycle so that you can get your work incorporated quickly.