Skip to content

Commit

Permalink
Horizon structural changes
Browse files Browse the repository at this point in the history
  • Loading branch information
briwylde08 committed Mar 1, 2024
1 parent 1c4f593 commit 238f733
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 27 deletions.
19 changes: 17 additions & 2 deletions platforms/horizon/README.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Horizon
title: Introduction
sidebar_position: 10
---

Horizon provides an HTTP API to data in the Stellar network. It ingests and re-serves the data produced by the Stellar network in a form that is easier to consume by the average application relative to the performance-oriented data representations used by Stellar Core.
Horizon provides an HTTP API to data in the Stellar network. It ingests and re-serves the data produced by the Stellar network in a form that is easier to consume by the average application relative to the performance-oriented data representations used by Stellar Core. This API serves the bridge between apps and [Stellar Core](/docs/run-core-node). Projects like wallets, decentralized exchanges, and asset issuers use Horizon to submit transactions, query an account balance, or stream events like transactions to an account.

Horizon can be accessed via cURL, a browser, or one of the [Stellar SDKs](/docs/tools/sdks). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls.

This guide describes how to administer a production Horizon instance (refer to the [Developers' Blog](https://www.stellar.org/developers-blog/a-new-sun-on-the-horizon) for some background on the performance and architectural improvements of this major version bump). For information about developing on the Horizon codebase, check out the [Development Guide](https://github.com/stellar/go/blob/master/services/horizon/internal/docs/GUIDE_FOR_DEVELOPERS.md).

Expand All @@ -15,3 +17,16 @@ Running Horizon within your own infrastructure provides a number of benefits. Yo

- Have full operational control without dependency on the Stellar Development Foundation for network data and transaction submission to networks;
- Run multiple instances for redundancy and scalability.

The Stellar Development Foundation (SDF) runs two instances of Horizon:

- [https://horizon.stellar.org/](https://horizon.stellar.org/) for interacting with the public network
- [https://horizon-testnet.stellar.org/](https://horizon-testnet.stellar.org/) for interacting with the [testnet](/docs/fundamentals-and-concepts/networks)

## In These Docs

- [Admin Guide](./admin-guide): how to set up your own Horizon instance.
- [Structure](./structure): how Horizon is structured.
- [Resources](./resources/index.mdx): descriptions of resources and their endpoints.
- [Aggregations](./aggregations/README.mdx): descriptions of specialized endpoints.
- [Errors](./errors/index.mdx): potential errors and what they mean.
2 changes: 1 addition & 1 deletion platforms/horizon/admin-guide/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Admin Guide
sidebar_position: 20
sidebar_position: 15
---

import DocCardList from "@theme/DocCardList";
Expand Down
26 changes: 2 additions & 24 deletions platforms/horizon/structure/README.mdx
Original file line number Diff line number Diff line change
@@ -1,30 +1,8 @@
---
title: Horizon API Reference
sidebar_position: 15
sidebar_position: 20
sidebar_label: Structure
description: Horizon is an API for interacting with the Stellar network.
---

import { MethodTable } from "@site/src/components/MethodTable";

Horizon is an API for interacting with the Stellar network.

This API serves the bridge between apps and [Stellar Core](/docs/run-core-node). Projects like wallets, decentralized exchanges, and asset issuers use Horizon to submit transactions, query an account balance, or stream events like transactions to an account.

Horizon is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) and can be accessed via cURL, a browser, or one of the [Stellar SDKs](/docs/tools/sdks). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls.

The Stellar Development Foundation (SDF) runs two instances of Horizon:

- [https://horizon.stellar.org/](https://horizon.stellar.org/) for interacting with the public network
- [https://horizon-testnet.stellar.org/](https://horizon-testnet.stellar.org/) for interacting with the [testnet](/docs/fundamentals-and-concepts/networks)

<MethodTable title="API Reference Sections">

| | |
| --- | --- |
| [Structure](../structure/README.mdx) | How Horizon is structured. |
| [Resources](../resources/index.mdx) | Descriptions of resources and their endpoints. |
| [Aggregations](../aggregations/README.mdx) | Descriptions of specialized endpoints. |
| [Errors](../errors/index.mdx) | Potential errors and what they mean. |

</MethodTable>
How Horizon is structured.

0 comments on commit 238f733

Please sign in to comment.