Check key and allowance

GET

https://api.xapichina.com

Identify the current API key

curl --request GET \
  --url https://api.xapichina.com/v1/me \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.xapichina.com/v1/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "email": "<string>",
  "plan": "<string>",
  "key_label": "<string>",
  "key_prefix": "<string>",
  "requests_this_month": 123,
  "monthly_cap": 123,
  "remaining": 123
}

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

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.

{
  "email": "[email protected]",
  "plan": "free",
  "key_label": "Development",
  "key_prefix": "xcn_EXAMPLE",
  "requests_this_month": 12,
  "monthly_cap": 500,
  "remaining": 488
}

Read the integration guide for parameter rules, source interpretation, and error handling. Use the generated request playground with your own server-side API key.

Authorizations

X-API-Key

string

header

required

Response

200 - application/json

Successful Response

string

required

plan

string

required

key_label

string

required

key_prefix

string

required

requests_this_month

integer

required

monthly_cap

integer | null

required

remaining

integer | null

required

⌘I

Identify the current API key

curl --request GET \
  --url https://api.xapichina.com/v1/me \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.xapichina.com/v1/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "email": "<string>",
  "plan": "<string>",
  "key_label": "<string>",
  "key_prefix": "<string>",
  "requests_this_month": 123,
  "monthly_cap": 123,
  "remaining": 123
}

Search

Catalog

Vehicles

Reports

Account

Check key and allowance

Behavior

Request example

Illustrative response

Authorizations

Response

​Behavior

​Request example

​Illustrative response

Authorizations

Response

Behavior

Request example

Illustrative response