API Docs

Explorer Lookup by Battery Name

LLM-ready context

Copies clean Markdown for pasting into an LLM.

Explorer Lookup by Battery Name

Find active ARC battery records by an exact, case-insensitive battery name when an external ID is not available.

GET /api/v1/explorer/vehicle/by-battery-name

Use this endpoint when an intake record has a battery name but no ARC external ID. Matching is exact after trimming and ignores letter case; partial or fuzzy matches are not performed.

Exact, case-insensitive match

ARC trims the input and compares the full battery name without regard to letter case. Partial names, wildcards, and fuzzy matches return no match.

Safe retries

In fail-closed metering modes, include Idempotency-Key and reuse the same value when retrying the same logical request. Do not reuse it for a different lookup.

Billing boundary

A successful response consumes one Explorer unit even when multiple batteries share the exact name. A no-match 404 does not consume Professional monthly quota or emit a Stripe Explorer meter unit, but it 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

FieldTypeDescription
battery_namestringRequired. Battery name to match exactly, ignoring letter case. The query value must be between 1 and 255 characters before trimming; ARC looks up the trimmed value.

Example Request

cURL
curl "https://api.autoresourceco.com/api/v1/explorer/vehicle/by-battery-name?battery_name=Hyundai%20Ioniq%20PHEV" \
  -H "X-API-Key: your_api_key_here" \
  -H "Idempotency-Key: battery-name-example-001"

Response Example

JSON
{
  "query": {
    "mode": "battery_name",
    "battery_name": "Hyundai Ioniq PHEV"
  },
  "vehicle": null,
  "batteries": [
    {
      "cathode_chemistry": "NMC",
      "chemistry_group": "Lithium-Ion",
      "dot_hazard_class": "Hazardous",
      "energy_kwh": 8.9
    }
  ],
  "result_count": 1
}

Response Fields

FieldTypeDescription
queryobjectNormalized request context with mode: battery_name and the trimmed name used for lookup.
vehiclenullAlways null because this lookup resolves batteries directly rather than decoding a vehicle.
batteriesobject[]One or more active records with the legacy minimal battery attributes. Multiple matches are ordered by energy_kwh descending, then external ID.
batteries[].cathode_chemistry / chemistry_groupstring | nullCathode chemistry and broader chemistry grouping when available.
batteries[].dot_hazard_classstring | nullDOT hazard classification when available.
batteries[].energy_kwhnumber | nullUsable battery energy in kilowatt-hours when available.
result_countintegerNumber of matching active battery records returned.

Related Docs