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

# API reference

> Every endpoint of the StockShift REST API, generated from the app's own routes.

This reference is generated from the StockShift app's routes, requests and responses, so it describes exactly what the API does. Each endpoint lists the permission and scope it needs, and you can try it from the page with your own API key.

## Base URL

```
https://app.stockshift.io/api/v1
```

Requests and responses are JSON. Send `Accept: application/json` and, with a body, `Content-Type: application/json`.

## Before you start

* [Authentication](https://docs.stockshift.io/guides/authentication.md): send an API key or an OAuth token as a bearer token.
* [Permissions and scopes](https://docs.stockshift.io/guides/permissions-and-scopes.md): what each token can reach.
* [Pagination](https://docs.stockshift.io/guides/pagination.md), [errors](https://docs.stockshift.io/guides/errors.md) and [rate limits](https://docs.stockshift.io/guides/rate-limits.md) work the same on every endpoint.

To generate your own client, download the whole OpenAPI document from the page menu.


## Related topics

- [Rust](https://docs.stockshift.io/sdks/rust.md)
- [.NET](https://docs.stockshift.io/sdks/dotnet.md)
- [Go](https://docs.stockshift.io/sdks/go.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.