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

# SquadAssist API Overview — REST Reference v1

> A complete reference to the SquadAssist REST API: base URL, available endpoints, authentication methods, and a working quickstart example.

The SquadAssist API is a REST API that returns JSON. All endpoints are served from a single base URL and use standard HTTP verbs and status codes.

## Base URL

```text theme={null}
https://api.squadassist.ai/v1
```

Every request path in this reference is relative to this base URL.

## API version

The current version is **v1**.

## Endpoints

These endpoints expose player and club analysis. Use them in server-to-server integrations with an API key.

| Method | Path                         | Auth required | Description                                                   |
| ------ | ---------------------------- | ------------- | ------------------------------------------------------------- |
| `GET`  | `/health`                    | No            | Liveness probe — returns `{"status": "ok"}`                   |
| `GET`  | `/player_positions`          | Yes           | List all available player positions                           |
| `GET`  | `/role_description`          | Yes           | Fetch SquadAssist role descriptions                           |
| `GET`  | `/player_info`               | Yes           | Retrieve profile data for a player                            |
| `GET`  | `/expected_transfer_value`   | Yes           | Current market value for a player                             |
| `POST` | `/get_roi_analysis`          | Yes           | Full ROI calculation for a player signing                     |
| `POST` | `/get_future_transfer_value` | Yes           | Predicted future transfer value                               |
| `POST` | `/get_sportive_impact`       | Yes           | Estimated team performance impact                             |
| `POST` | `/query_player`              | Yes           | Look up a player by Transfermarkt, Wyscout, or SquadAssist ID |
| `POST` | `/query_club`                | Yes           | Look up a club by Transfermarkt or SquadAssist ID             |

## Quickstart

The `/health` endpoint requires no credentials and confirms the API is reachable.

<CodeGroup>
  ```bash curl theme={null}
  curl https://api.squadassist.ai/v1/health
  ```

  ```json Response theme={null}
  {
    "status": "ok",
    "service": "squadassist-api"
  }
  ```
</CodeGroup>

## Response format

All responses — including errors — are JSON objects. Successful responses vary in shape per endpoint. Error responses always include an `"error"` key with a string description. See [Errors](/api-reference/errors) for the full list of error codes and response bodies.