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

# Introduction

> N3 Service API endpoint showcase

<Note>
  An API Key is required to access some N3 endpoints to pull analytical data
  from the platform. Pay attention to the authorization information for
  endpoints.
</Note>

## About our API

We maintain an OpenAPI spec of our API - See: [OpenAPI Specification](https://swagger.io/specification/). If you are thinking of integrating our API with your service, we recommend using the following OpenAPI specification.

<Card title="N3 Endpoints" icon="file">
  Get in touch to request the OpenAPI specification file.
</Card>

## Authentication

Personal API endpoints are authenticated using Bearer tokens and picked up from the specification file.

```json theme={null}
"security": [
  {
    "bearerAuth": []
  }
]
```

Analytical API endpoints are authorised using an API KEY in the header of requests. This key will be subject to rate limits and fair usage.

```json theme={null}
X-API-KEY: <your key>
```