> ## 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.

# Check key and allowance

> Identify your key, account plan, and remaining monthly allowance.

## Behavior

This endpoint requires an API key but does not consume data quota. Usage and allowance are account-wide rather than independent per key. `monthly_cap` and `remaining` are `null` for an uncapped account; null does not mean zero.

**Authentication:** Secret API key in `X-API-Key`. **Quota:** Does not consume data quota.

## Request example

```bash theme={"system"}
curl --fail-with-body "https://api.xapichina.com/v1/me" \
  -H "X-API-Key: $XAPICHINA_API_KEY"
```

## Illustrative response

The following example is abbreviated. It demonstrates the response shape rather than live inventory or guaranteed field coverage. The generated schema describes the complete contract.

```json theme={"system"}
{
  "email": "developer@example.com",
  "plan": "free",
  "key_label": "Development",
  "key_prefix": "xcn_EXAMPLE",
  "requests_this_month": 12,
  "monthly_cap": 500,
  "remaining": 488
}
```

Read the [integration guide](/plans-and-billing) for parameter rules, source interpretation, and error handling. Use the generated request playground with your own server-side API key.


## OpenAPI

````yaml openapi.json GET /v1/me
openapi: 3.1.0
info:
  title: XAPI China
  description: >-
    Search Chinese used-car listings and retrieve vehicle details, photos,
    CNY/EUR prices, and supported provider-native inspection data.


    XAPI China is an independent service and is not affiliated with or endorsed
    by Che168.


    Authenticate data requests with X-API-Key. GET /v1/makes and GET /v1/filters
    are public. English responses are the default; use lang=zh for Chinese
    output.


    Inspection coverage is explicit. Insurance-event query evidence is not
    structured insurance claim history.


    Create keys and check your account-wide allowance in the XAPI China
    dashboard: https://xapichina.com/dashboard.
  version: 1.0.0
servers:
  - url: https://api.xapichina.com
    description: Production
security: []
paths:
  /v1/me:
    get:
      tags:
        - API Keys
      summary: Identify the current API key
      operationId: me_v1_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    MeResponse:
      properties:
        email:
          type: string
          title: Email
        plan:
          type: string
          title: Plan
        key_label:
          type: string
          title: Key Label
        key_prefix:
          type: string
          title: Key Prefix
        requests_this_month:
          type: integer
          title: Requests This Month
        monthly_cap:
          anyOf:
            - type: integer
            - type: 'null'
          title: Monthly Cap
        remaining:
          anyOf:
            - type: integer
            - type: 'null'
          title: Remaining
      type: object
      required:
        - email
        - plan
        - key_label
        - key_prefix
        - requests_this_month
        - monthly_cap
        - remaining
      title: MeResponse
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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