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

# PSNTools API

> Programmatic access to PSNTools — authentication, scopes, and billing.

<Note>
  The PSNTools API is not available yet. These pages are placeholders that outline the shape of the API. Endpoints, field names, and limits below are **not final** and will change before release.
</Note>

The API will let you use PSNTools programmatically instead of through the website — looking up accounts, reading avatar and trophy data, and pulling your own purchase history.

## Getting started

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    How to get an API key and sign your requests.
  </Card>

  <Card title="Scopes" icon="shield-halved" href="/api/scopes">
    Permissions that control what a key is allowed to do.
  </Card>

  <Card title="Billing" icon="credit-card" href="/api/billing">
    How API usage is metered and charged.
  </Card>
</CardGroup>

## Base URL

All requests will go to a single base URL, with the version in the path:

```text theme={null}
https://api.psntools.com/v1
```

## Conventions

|            |                                                   |
| ---------- | ------------------------------------------------- |
| Format     | JSON request and response bodies                  |
| Auth       | Bearer token in the `Authorization` header        |
| Errors     | Standard HTTP status codes with a JSON error body |
| Versioning | Major version in the URL path (`/v1`)             |

<Info>
  Want early access or have questions about the API? Ask in the [PSNTools Discord](https://discord.gg/Mz3cQjq9qw).
</Info>


## Related topics

- [Authentication](/api/authentication.md)
- [Billing](/api/billing.md)
- [Scopes](/api/scopes.md)
- [Create a PSNTools account](/account-billing/your-account/create-account.md)
- [Get your NPSSO token](/account-billing/your-account/npsso-token.md)