Explorer Lookup by Battery External ID

Resolve a known ARC battery external ID to the legacy minimal battery attributes used by Explorer integrations.

GET /api/v1/explorer/vehicle/by-battery-external-id

Use this endpoint when a record already contains an ARC battery external ID and you need the concise chemistry, hazard, and energy attributes for that pack.

Authentication

Include X-API-Key on every request. This route is server-to-server and uses the Explorer rate-limit headers.

Idempotency

Include an Idempotency-Key with every request. Use a unique value for each logical request, and reuse the same value only when retrying that exact request. Use a new key when any input changes.

Billing boundary

A successful lookup consumes one Explorer unit. If the active battery does not exist, the endpoint returns 404 without consuming monthly usage. The request still counts toward the per-minute rate limit.

Response caching

Successful responses use Cache-Control: private, no-store because they are authenticated and metered.

Query Parameters

Field	Type	Description
battery_external_id	string	Required. ARC battery external ID. The query value must be between 1 and 100 characters before trimming; ARC looks up the trimmed value.

Example Request

cURL

curl "https://api.autoresourceco.com/api/v1/explorer/vehicle/by-battery-external-id?battery_external_id=BAT-1z90cu" \
  -H "X-API-Key: your_api_key_here" \
  -H "Idempotency-Key: battery-external-id-example-001"

Response Example

JSON

{
  "query": {
    "mode": "battery_external_id",
    "battery_external_id": "BAT-1z90cu"
  },
  "vehicle": null,
  "batteries": [
    {
      "cathode_chemistry": "NMC",
      "chemistry_group": "Lithium-Ion",
      "dot_hazard_class": "Hazardous",
      "energy_kwh": 8.9
    }
  ],
  "result_count": 1
}

Response Fields

Field	Type	Description
query	object	Normalized request context with mode: battery_external_id and the requested external ID.
vehicle	null	Always null because this lookup resolves a battery directly rather than decoding a vehicle.
batteries	object[]	Array containing the matching active battery's legacy minimal attributes.
batteries[].cathode_chemistry / chemistry_group	string \| null	Cathode chemistry and broader chemistry grouping when available.
batteries[].dot_hazard_class	string \| null	DOT hazard classification when available.
batteries[].energy_kwh	number \| null	Usable battery energy in kilowatt-hours when available.
result_count	integer	Number of matching battery records returned; normally 1 for an external ID lookup.

Related Docs

Authentication Errors and Limits