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

# API overview

> Every public China API endpoint, its authentication, and its quota behavior.

## Base URL and authentication

```text theme={"system"}
https://api.xapichina.com
```

The public API is versioned under `/v1`. Authenticated endpoints require a secret key in `X-API-Key`. Requests and responses use HTTP and JSON; no SDK is required.

## Endpoint map

| Endpoint | Purpose | API key | Consumes data quota |
| - | - | - | - |
| [GET /v1/search](/api-reference/search) | Search listings with structured filters | Yes | Yes |
| [GET /v1/search/count](/api-reference/count) | Count listings with the same filters | Yes | Yes |
| [GET /v1/filters](/api-reference/filters) | Discover valid search values | No | No |
| [GET /v1/makes](/api-reference/makes) | List manufacturers | No | No |
| [`GET /v1/makes/{make}/models`](/api-reference/models) | Discover models for a manufacturer | Yes | Yes |
| [`GET /v1/cars/{car_id}`](/api-reference/details) | Load normalized details, photos, and native data | Yes | Yes |
| [`GET /v1/cars/{car_id}/images`](/api-reference/images) | Retrieve photo URLs | Yes | Yes |
| [`GET /v1/cars/{car_id}/similar`](/api-reference/similar) | Retrieve related listings | Yes | Yes |
| [`GET /v1/cars/{car_id}/inspection`](/api-reference/inspection) | Retrieve report summary or full findings | Yes | Yes |
| [`GET /v1/cars/{car_id}/insurance`](/api-reference/insurance) | Retrieve insurance-event query evidence | Yes | Yes |
| [GET /v1/me](/api-reference/me) | Identify your key and remaining allowance | Yes | No |

The **API Reference** tab includes an interactive request builder, required parameters, response types, and endpoint-specific guidance for each of these 11 routes.

## Request conventions

* Search pages start at 1 and contain up to the upstream page size of 24.
* Search does not support a caller-selected `limit`. Similar listings do, from 1 to 24.
* Supported language parameters are `en` and `zh`, with English as the default.
* CNY prices and mileage search bounds use 10,000-unit steps.
* EUR filters round inward to Che168's supported CNY price steps.
* All authenticated data requests share your account's quota and per-minute limit, across every key.

## Data contracts

Search returns a `SearchResponse` with `results` and `next_page`. Detail returns a `CarDetail` with normalized fields and a provider-native `che168` block. Inspections return `InspectionSummary` by default or `InspectionReport` with `view=full`.

Unknown values can be `null` or omitted in native data. Coverage fields explain whether a report is advertised, accessible, and parsed. Structured insurance claim history is currently unavailable.

## Dashboard operations

Use the [dashboard](https://xapichina.com/dashboard) to create/revoke keys, inspect usage, manage billing, and update your account. Its internal session/JWT routes are separate from the customer API-key interface and are not part of this public reference.

<CardGroup cols={2}>
  <Card title="Make your first request" icon="rocket" href="/quickstart">Create a key and search Chinese inventory.</Card>
  <Card title="Interpret source fields" icon="database" href="/data-fields">Keep normalized values, native fields, and unknown data distinct.</Card>
</CardGroup>


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