> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goldsky.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stellar

export const chainName_0 = "Stellar"

export const ChainOverview = ({chainName}) => <p>Goldsky is the modern back-end for crypto-enabled products; the infrastructure layer between your application and the blockchain. We handle the complex, undifferentiated work of building on crypto rails: streaming real-time data, maintaining reliable chain connectivity, and executing onchain logic. Teams use Goldsky to ship faster and stay focused on their core product.</p>;

## Overview

<ChainOverview chainName="Stellar" />

### Partnership

Goldsky has partnered with {chainName_0} to make our product available to the ecosystem and provide dedicated support for {chainName_0}. Below in the overview of each product, the "Partner Sponsored" tag indicates that usage of that product is fully covered by the chain, if approved by the {chainName_0} team. Where this perk is available, please reach out to the developer relations team for an access code to the private signup form.

## Getting started

To use Goldsky, you'll need to create an account, install the CLI, and log in. If you want to use Turbo or Compose, you'll also need to install their respective CLI extensions.

<AccordionGroup>
  <Accordion title="Install Goldsky CLI and log in">
    1. Install the Goldsky CLI:

       **For macOS/Linux:**

       ```shell theme={null}
       curl https://goldsky.com | sh
       ```

       **For Windows:**

       ```shell theme={null}
       npm install -g @goldskycom/cli
       ```

       <Note>Windows users need to have Node.js and npm installed first. Download from [nodejs.org](https://nodejs.org) if not already installed.</Note>
    2. Go to your [Project Settings](https://app.goldsky.com/dashboard/settings) page and create an API key.
    3. Back in your Goldsky CLI, log into your Project by running the command `goldsky login` and paste your API key.
    4. Now that you are logged in, run `goldsky` to get started:
       ```shell theme={null}
       goldsky
       ```
  </Accordion>

  <Accordion title="Install Turbo CLI extension">
    If you already have the Goldsky CLI installed, install the Turbo extension by running:

    ```bash theme={null}
    goldsky turbo
    ```

    This will automatically install the Turbo extension. Verify the installation:

    ```bash theme={null}
    goldsky turbo list
    ```

    <Note>
      Make sure to update the CLI to the latest version before running Turbo commands: `curl https://goldsky.com | sh`
    </Note>

    For a complete reference of all Turbo CLI commands, see the [CLI Reference](/turbo-pipelines/cli-reference) guide.
  </Accordion>

  <Accordion title="Install Compose CLI extension">
    <Warning>
      Compose is currently in private beta and access is invite-only. The following commands will not work unless you have been explicitly whitelisted by the Goldsky team. Enterprise customers can contact their Account Manager for expedited early access.
    </Warning>

    If you already have the Goldsky CLI installed, install the Compose extension by running:

    ```bash theme={null}
    goldsky compose install
    ```

    To update to the latest version:

    ```bash theme={null}
    goldsky compose update
    ```

    For more details, see the [Compose quickstart](/compose/quick-start) guide.
  </Accordion>
</AccordionGroup>

## Turbo

<p>
  <span style={{display: 'inline-block', padding: '2px 8px', borderRadius: '4px', fontSize: '12px', fontWeight: '600', marginRight: '6px', backgroundColor: 'rgba(34, 197, 94, 0.1)', color: 'rgba(34, 197, 94, 0.6)'}}>MAINNET SUPPORTED</span>
  <span style={{display: 'inline-block', padding: '2px 8px', borderRadius: '4px', fontSize: '12px', fontWeight: '600', marginRight: '6px', backgroundColor: 'rgba(59, 130, 246, 0.1)', color: 'rgba(59, 130, 246, 0.6)'}}>TESTNET SUPPORTED</span>
</p>

Turbo pipelines provide high-performance streaming data pipelines with sub-second latency. Deploy a pipeline to start streaming Stellar data to your preferred destination.

### Quick config

```yaml stellar-transactions.yaml theme={null}
name: my-stellar-transactions
resource_size: s

sources:
  stellar_transactions:
    type: dataset
    dataset_name: stellar_mainnet.transactions
    version: 1.2.0
    start_at: latest

sinks:
  my_sink:
    type: postgres
    from: stellar_transactions
    schema: public
    table: stellar_transactions
    secret_name: MY_POSTGRES_SECRET
    primary_key: transaction_hash
```

Deploy with:

```bash theme={null}
goldsky turbo apply stellar-transactions.yaml
```

### Available chain slugs

Mainnet: `stellar_mainnet` | Testnet: `stellar_testnet`

Goldsky provides real-time (under 5 seconds) streaming of Stellar datasets, including all historical data, for both mainnet and testnet. Datasets include ledgers, transactions, operations, events, transfers, ledger entries, and balances.

<Note>
  The Stellar testnet is frequently reset (typically about once every third month). We recommend deploying testnet pipelines with `start_at: latest` to ensure they always index from the most recent testnet version.
</Note>

For available datasets, schemas, version details, and pipeline examples, see the [Stellar Turbo Sources](/turbo-pipelines/sources/stellar) guide.

## Getting support

Can't find what you're looking for? Reach out to us at [support@goldsky.com](mailto:support@goldsky.com) for help.