{"templateId":"openapi_docs","versions":[{"version":"v3","label":"Current","link":"/apis/prices","default":true,"active":false,"folderId":"58c9a61d"},{"version":"v2","label":"Legacy","link":"/apis/v2/prices","default":false,"active":true,"folderId":"58c9a61d"}],"sharedDataIds":{"openAPIDocsStore":"oas-apis/@v2/prices.yml","sidebar":"sidebar-apis/@v2/sidebars.yaml"},"props":{"definitionId":"apis/@v2/prices.yml","dynamicMarkdocComponents":[],"baseSlug":"/apis/v2/prices","seo":{"title":"Benchmark Mineral Intelligence API"},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Benchmark Mineral Intelligence API","description":"The Benchmark API provides access to a comprehensive range of pricing data for various markets to empower your most critical energy transition decisions. This API is designed with the principles of REST architecture, ensuring scalability, flexibility, and ease of use for integrating with your systems. It follows RESTful best practices, leveraging HTTP methods and status codes for predictable interactions, allowing for seamless integration with web applications or services.\n\nAccess to our API is secured using an API key. Users must include their unique API key in the request header x-api-key to authenticate their requests. This ensures secure and controlled access to the API’s data.\n\nRate limiting is applied to manage the number of requests a client can make within a defined period. The specific rate limits can be configured based on your business requirements to ensure fair usage and avoid abuse.\n\nThe API offers structured responses in JSON format, providing essential details for retrieving and submitting price data. It is built to handle a variety of pricing data queries and submissions efficiently.\n\n**API endpoint structure**\n\nAll endpoints of the Benchmark Minerals Prices API follow a clear and logical structure, with versioning included in the URL to ensure backward compatibility:\n\n- Base URL: <span class=\"url-doc\">`https://api.benchmarkminerals.com/v2`</span>\n- Endpoints:\n  - <span class=\"url-doc\">`/prices/cathode`</span> – Retrieves cathode pricing data with the GET method.\n\nEndpoints are categorised by the type of market pricing data, allowing clients to interact with different markets and products. Each request can be authenticated with the x-api-key  header, and structured responses will be provided in JSON format.\n\n**Terms of use**\n\nBy accessing and using the Benchmark API, you agree to comply with the terms and conditions outlined in the supply agreement between the entity you represent and Benchmark Mineral Intelligence. key points include:\n- data usage: the data provided through this API is intended for internal use only;\n- rate limiting: exceeding the defined rate limits may result in temporary suspension of access;\n- data privacy: any personal data transmitted or received through the API is subject to our privacy policy and supply agreement, which outlines the handling of sensitive information; and  \n- intellectual property: All content, including data and API documentation, is the intellectual property of Benchmark Mineral Intelligence Limited and may not be redistributed or modified without explicit permission from Benchmark Mineral Intelligence Limited.\n\n**Support**\n\nIf you encounter any issues or need assistance with using the Benchmark API, our team is here to help with any technical inquiries, troubleshooting, or general questions about the API.\n\nIf you require access or technical support, please [contact our team](https://www.benchmarkminerals.com/contact/)\n\nFor more details on specific endpoints, request/response structures, and authentication, please refer to the sections below."},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"api-docs.benchmarkminerals.com","port":4000,"ipAddress":"216.73.216.90"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis/v2/prices","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}