Health check endpoints
Prices
/- Get Lithium Ion Battery market index data
Get Lithium Ion Battery market prices
Get Lithium Ion Battery m...
Prices API V3 - OpenAPI 3.0 (1.0.0)
API for retrieving critical mineral and energy transition prices across multiple markets with support for currency conversion, unit of measure conversion, and dynamic filtering based on market configuration.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://api-docs.benchmarkminerals.com/_mock/apis/prices
Production server
https://api.benchmarkminerals.com/v3/prices
Request
Retrieve prices for the Lithium Ion Battery market with dynamic filtering.
Available filters for Lithium Ion Battery:
- products, priceCategories, priceTypes (base filters)
- capacities, cellFormats, incoterms, countries, regions, tradeTypes (market-specific)
- codes (exclusive filter - when used, only dateFrom/dateTo allowed)
Security
bearerAuth and api_key(Required scopes:
prices:lithium-ion-battery
)- Mock serverhttps://api-docs.benchmarkminerals.com/_mock/apis/prices/lithium-ion-battery
- Production serverhttps://api.benchmarkminerals.com/v3/prices/lithium-ion-battery
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- Basic request
- Filtered by date range
- Filter by product codes
- List available price series
- Include summary statistics
curl -i -X POST \
https://api-docs.benchmarkminerals.com/_mock/apis/prices/lithium-ion-battery \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"filters": {
"dateFrom": "2024-01-01",
"dateTo": "2024-12-31"
},
"options": {
"includeSeries": true
}
}'Response
application/json
{ "$metadata": { "market": "Lithium Ion Battery" }, "data": [ { … } ], "specification": [ { … }, { … } ], "assessmentLaunchedAt": "2022-01-15", "lastAssessedAt": "2024-12-15", "product": { "id": "550e8400-e29b-41d4-a716-446655440030", "name": "LFP Cell", "alias": "LFP", "chemicalCode": "LiFePO4", "isSustainable": true }, "priceCategory": { "id": "550e8400-e29b-41d4-a716-446655440001", "name": "Spot" }, "frequency": { "id": "550e8400-e29b-41d4-a716-446655440002", "name": "Weekly", "shortName": "W" }, "capacity": { "id": "550e8400-e29b-41d4-a716-446655440031", "name": "100Ah" }, "cellFormat": { "id": "550e8400-e29b-41d4-a716-446655440032", "name": "Prismatic" }, "incoterm": { "id": "550e8400-e29b-41d4-a716-446655440004", "name": "CIF" }, "country": { "id": "550e8400-e29b-41d4-a716-446655440033", "name": "Germany" }, "region": { "id": "550e8400-e29b-41d4-a716-446655440034", "name": "Europe" }, "tradeType": { "id": "550e8400-e29b-41d4-a716-446655440023", "name": "Contract" }, "unitOfMeasure": { "id": "550e8400-e29b-41d4-a716-446655440035", "name": "Kilowatt-hour", "symbol": "kWh" }, "currency": { "id": "550e8400-e29b-41d4-a716-446655440009", "name": "US Dollar", "iso": "USD", "symbol": "$" }, "priceType": { "id": "550e8400-e29b-41d4-a716-446655440010", "name": "Price" }, "series": [ { … } ] }
Request
Retrieve price index data for the Lithium Ion Battery market. Returns index values with summary statistics and time series data.
Security
bearerAuth and api_key(Required scopes:
prices:lithium-ion-battery
)- Mock serverhttps://api-docs.benchmarkminerals.com/_mock/apis/prices/lithium-ion-battery/index
- Production serverhttps://api.benchmarkminerals.com/v3/prices/lithium-ion-battery/index
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- Basic request
- Filtered by date range
curl -i -X POST \
https://api-docs.benchmarkminerals.com/_mock/apis/prices/lithium-ion-battery/index \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"filters": {
"dateFrom": "2024-01-01",
"dateTo": "2024-12-31"
}
}'Response
application/json
{ "$metadata": { "market": "Lithium ion Battery Cell" }, "data": [ { … } ] }