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

# Introduction

> Welcome to Substack API, the unofficial open-source API for Substack publications.

<img className="block dark:hidden rounded-lg" src="https://static.noahbjorner.com/substackapi/substackapi-light-cover.webp" alt="Hero Light" />

<img className="hidden dark:block rounded-lg" src="https://static.noahbjorner.com/substackapi/substackapi-dark-cover.webp" alt="Hero Dark" />

## What is Substack API?

Substack API allows Substack publications to access their content and display it on their own websites or applications. The API provides:

* Fast and reliable access to your publication's content
* Simple authentication using API keys
* Free to use with generous rate limits

## Available Endpoints

<CardGroup>
  <Card title="Latest Posts" icon="clock" href="/api-reference/endpoint/posts-latest">
    Get the latest posts from your publication.
  </Card>

  <Card title="Top Posts" icon="trophy" href="/api-reference/endpoint/posts-top">
    Get the most popular posts from your publication.
  </Card>

  <Card title="Search Posts" icon="magnifying-glass" href="/api-reference/endpoint/posts-search">
    Search for posts in your publication.
  </Card>

  <Card title="Single Post" icon="newspaper" href="/api-reference/endpoint/post">
    Get a single post from your publication by slug.
  </Card>
</CardGroup>

## How to get started

<Steps>
  <Step title="Generate an API Key">
    Visit the [API Key Generator](https://auth.substackapi.dev) to create your API key. You'll need your Substack publication URL.
  </Step>

  <Step title="Use the API Key">
    Include your API key in the `X-API-Key` header when making requests to the API.
  </Step>

  <Step title="Explore the API">
    Refer to the [API Reference](/api-reference) for detailed endpoint documentation and examples.
  </Step>
</Steps>

<Tip>
  You can try out the API without an API key using the [Try it](/api-reference/endpoint/posts-latest) feature available for all endpoints.
</Tip>

<Note>
  For a detailed walkthrough, check out our video tutorial and step-by-step guide in the [Quickstart](/quickstart) page.
</Note>

## Need Help?

* Check out our [FAQ](/faq) for common questions
* View the technical details in our [Technical Overview](/technical-overview)
* Contact the developer at [bjornernoah@gmail.com](mailto:bjornernoah@gmail.com)
* View the source code on [GitHub](https://github.com/Noah-Bjorner/SubstackAPI)