OPTIMADE API

{
  "service_type": "platform",
  "base_url": "https://optimade.local",
  "auth_method": "none",
  "auth_config": {},
  "endpoints": [
    {
      "path": "/v1/info",
      "method": "GET",
      "description": "Retrieve service metadata including available endpoints and API version."
    },
    {
      "path": "/v1/links",
      "method": "GET",
      "description": "List links to other OPTIMADE providers in the federation."
    },
    {
      "path": "/v1/structures",
      "method": "GET",
      "description": "Query structures with filters, pagination, and response fields."
    },
    {
      "path": "/v1/structures/{id}",
      "method": "GET",
      "description": "Retrieve a single structure entry by its identifier."
    },
    {
      "path": "/v1/references",
      "method": "GET",
      "description": "Query bibliographic references associated with entries."
    },
    {
      "path": "/v1/references/{id}",
      "method": "GET",
      "description": "Retrieve a single reference entry by its identifier."
    },
    {
      "path": "/v1/calculations",
      "method": "GET",
      "description": "Query calculated properties for structures (if supported by the provider)."
    },
    {
      "path": "/v1/calculations/{id}",
      "method": "GET",
      "description": "Retrieve a single calculation entry by its identifier."
    }
  ],
  "pricing_model": {
    "type": "free",
    "details": {
      "notes": "OPTIMADE is an open consortium specification; individual provider deployments are typically free to query, though underlying data sources may have their own terms."
    }
  },
  "rate_limits": {
    "notes": "Not specified by the OPTIMADE specification; rate limiting is deployment-specific. Check provider headers such as X-RateLimit-Limit and X-RateLimit-Remaining where implemented."
  },
  "capabilities": [
    "Federated discovery of materials databases",
    "Common REST API for querying structures, references, and calculations",
    "JSON:API-compliant response format",
    "Filtering and pagination via query parameters",
    "Cross-provider linking via /links endpoint",
    "Schema and metadata discovery via /info",
    "Provider-agnostic client tooling",
    "Open specification with reference server implementations"
  ],
  "raw_analysis": "OPTIMADE (Open Databases Integration for Materials Design) is a consortium and specification that defines a common REST API for materials science databases. The service at https://optimade.local appears to be a local or reference deployment of an OPTIMADE-compliant API server. The API is JSON:API-based, uses standard HTTP methods, and typically requires no authentication for read access, though individual providers may impose API keys or rate limits. Core endpoints follow the /v1/<entrytype> pattern, with /info and /links providing discovery metadata. The platform is mature and widely adopted in the materials science community (e.g., by Materials Project, OQMD, AFLOW, NOMAD, COD, and others). It targets researchers, data scientists, and tool developers who need programmatic access to materials data across heterogeneous databases. Integration is primarily via HTTP clients, with official Python libraries (optimade-python-tools) and client support in several materials informatics tools. Since the base URL is a .local address, this is likely a development or self-hosted instance; production usage would point to public provider URLs."
}

0/3 tests passed

{
  "overall": 68,
  "dimensions": {
    "token_efficiency": 8.5,
    "first_try_success": 6.0,
    "response_parseability": 9.5,
    "error_clarity": 7.5,
    "doc_quality": 8.0,
    "auth_simplicity": 10.0,
    "latency": 3.0,
    "consistency": 5.5
  },
  "pricing_normalized": {
    "model": "free",
    "notes": "OPTIMADE is an open specification; provider deployments are generally free to query. Underlying data sources may impose their own terms."
  },
  "issues": [
    "Check harness could not resolve the domain (DNS failure) for website uptime, robots.txt, and llms.txt probes — no live HTTP verification was possible.",
    "The test targets appear to be a specification/standard rather than a single hosted API, so results depend heavily on the chosen provider endpoint.",
    "No single canonical endpoint to benchmark; latency and uptime vary per federated provider.",
    "No llms.txt or robots.txt was retrievable, limiting agent-oriented discoverability signals."
  ],
  "recommendations": [
    "Point Prowl checks at a concrete provider base URL (e.g., a live OPTIMADE deployment) rather than the consortium/spec site.",
    "Publish an llms.txt and explicit robots directives on the reference site to improve agent discoverability.",
    "Document per-provider uptime/status pages so agents can surface reliable endpoints to users.",
    "Provide a stable hosted reference server so first-try-success and latency can be measured meaningfully."
  ]
}