{ "openapi": "3.1.0", "info": { "title": "actuatorlist API", "version": "1.0.0", "summary": "Read-only REST API over the actuatorlist robot actuator and robot catalog.", "description": "Free, anonymous, read-only access to every actuator and robot on https://actuatorlist.com. No API key, no account, no writes: production is safe to call, so there is no separate sandbox.\n\n**Rate limits:** 120 requests per 60s per client IP, reported in `RateLimit`/`RateLimit-Policy` and `X-RateLimit-*` headers; a 429 carries `Retry-After`.\n\n**Errors:** RFC 9457 `application/problem+json` with a stable `code`.\n\n**License:** the API description and code are under the MIT License; the data it returns is CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/), credit \"actuatorlist.com (Eito Miyamura)\". Product photos, logos and headshots are not covered: they belong to their owners and are shown only for identification.\n\n**Versioning and deprecation:** Breaking changes ship only under a new path version (/api/v2). A deprecated operation keeps working for at least 6 months after it is marked: responses carry `Deprecation` (RFC 9745) and `Sunset` (RFC 8594) headers plus a `Link rel=\"deprecation\"` to the changelog, and the operation is flagged `deprecated: true` here. Additive changes (new fields, endpoints, filters) can land at any time, so clients should ignore unknown fields.", "contact": { "name": "actuatorlist on GitHub", "url": "https://github.com/Miyamura80/getactuators/issues" }, "license": { "name": "MIT License", "identifier": "MIT" }, "x-deprecation-policy": "Breaking changes ship only under a new path version (/api/v2). A deprecated operation keeps working for at least 6 months after it is marked: responses carry `Deprecation` (RFC 9745) and `Sunset` (RFC 8594) headers plus a `Link rel=\"deprecation\"` to the changelog, and the operation is flagged `deprecated: true` here. Additive changes (new fields, endpoints, filters) can land at any time, so clients should ignore unknown fields." }, "servers": [ { "url": "https://actuatorlist.com", "description": "Production. Read-only, so it doubles as the sandbox." } ], "security": [], "tags": [ { "name": "actuators", "description": "Actuator search, detail and comparison." }, { "name": "robots", "description": "Robots and the motors in their joints." }, { "name": "taxonomy", "description": "Categories, brands and use cases for filters." }, { "name": "meta", "description": "Discovery: index and this document." }, { "name": "supply-chain", "description": "Companies, sites, magnet metals (supply, reserves, prices) and policy measures along the actuator supply chain, with citations." } ], "externalDocs": { "description": "Developer guide", "url": "https://actuatorlist.com/docs/api" }, "paths": { "/api": { "get": { "operationId": "get_api_index", "summary": "API index", "description": "Machine-readable entry point: every endpoint with its method and summary, plus links to the docs, the OpenAPI document and the MCP server.", "tags": [ "meta" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiIndex" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/openapi.json": { "get": { "operationId": "get_openapi_spec", "summary": "OpenAPI document", "description": "This OpenAPI 3.1 description of the API (also at /api/openapi.json).", "tags": [ "meta" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApiDocument" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/actuators": { "get": { "operationId": "list_actuators", "summary": "Search and filter actuators", "description": "List robot actuators with optional filters (text, category, brand, use case, torque, mass, price, backdrivability, onboard driver) and sorting. Cursor-paginated: follow `pagination.next_cursor` until `has_more` is false.", "tags": [ "actuators" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Free-text search over id, name, brand, category, use cases, notes.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "Category slug.", "schema": { "type": "string", "enum": [ "qdd_proprioceptive", "integrated_joint", "smart_servo", "harmonic_precision", "frameless_driver", "cycloidal_premium" ] } }, { "name": "brand", "in": "query", "required": false, "description": "Exact brand name (case-insensitive).", "schema": { "type": "string" } }, { "name": "use_case", "in": "query", "required": false, "description": "Use-case tag, e.g. `humanoid`.", "schema": { "type": "string" } }, { "name": "min_peak_torque_nm", "in": "query", "required": false, "description": "Minimum peak torque in N·m.", "schema": { "type": "number", "minimum": 0 } }, { "name": "max_weight_g", "in": "query", "required": false, "description": "Maximum mass in grams.", "schema": { "type": "number", "minimum": 0 } }, { "name": "max_price_usd", "in": "query", "required": false, "description": "Maximum list price in USD.", "schema": { "type": "number", "minimum": 0 } }, { "name": "backdrivable", "in": "query", "required": false, "description": "Only backdrivable (`true`) or non-backdrivable (`false`).", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "integrated_driver", "in": "query", "required": false, "description": "Only actuators with (`true`) or without an onboard driver.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "sort", "in": "query", "required": false, "description": "Sort field (default: id).", "schema": { "type": "string", "enum": [ "peak_torque_nm", "rated_torque_nm", "max_speed_rpm", "weight_g", "torque_density_nm_per_kg", "price_usd", "price_per_nm", "backlash_arcmin", "name" ] } }, { "name": "order", "in": "query", "required": false, "description": "Sort direction (default desc when `sort` is set).", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Page size, 1 to 100 (default 25).", "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque `pagination.next_cursor` from the previous page.", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActuatorList" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/actuators/compare": { "get": { "operationId": "compare_actuators", "summary": "Fetch several actuators by id", "description": "Batch lookup of up to 20 actuators by id for side-by-side comparison. Results keep request order; unknown ids are listed in `not_found` instead of failing the whole request.", "tags": [ "actuators" ], "parameters": [ { "name": "ids", "in": "query", "required": true, "description": "Comma-separated actuator ids, 1 to 20, e.g. `a,b,c`.", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompareResult" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } }, "post": { "operationId": "compare_actuators_batch", "summary": "Fetch several actuators by id (JSON body)", "description": "Same as `compare_actuators` but takes `{\"ids\": [...]}` (1 to 20 ids) as a JSON body. Read-only and safe to retry: an `Idempotency-Key` header is accepted but not required.", "tags": [ "actuators" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompareRequest" } } } }, "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompareResult" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "415": { "$ref": "#/components/responses/Problem415" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/actuators/{id}": { "get": { "operationId": "get_actuator", "summary": "Get one actuator", "description": "Full specifications for one actuator, plus `robots_using`: the robots in the catalog whose joints use it.", "tags": [ "actuators" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Actuator id (slug).", "schema": { "type": "string", "examples": [ "robstride-02" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActuatorDetail" } } } }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/robots": { "get": { "operationId": "list_robots", "summary": "List robots", "description": "Robots (arms, humanoids, quadrupeds) in the catalog with headline specs. Cursor-paginated like `list_actuators`.", "tags": [ "robots" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Free-text search over name, brand, summary.", "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "description": "Exact brand name (case-insensitive).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size, 1 to 100 (default 25).", "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque `pagination.next_cursor` from the previous page.", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RobotList" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/robots/{id}": { "get": { "operationId": "get_robot", "summary": "Get one robot with its joint motors", "description": "One robot with every joint group resolved to its motor specs, linked to the matching catalog actuator when there is one.", "tags": [ "robots" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Robot id (slug).", "schema": { "type": "string", "examples": [ "i2rt-yam" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RobotDetail" } } } }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/categories": { "get": { "operationId": "list_categories", "summary": "List actuator categories", "description": "Every category slug with a label, description and actuator count.", "tags": [ "taxonomy" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryList" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/brands": { "get": { "operationId": "list_brands", "summary": "List actuator brands", "description": "Every brand name (usable as the `brand` filter) with its actuator count.", "tags": [ "taxonomy" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedCountList" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/use-cases": { "get": { "operationId": "list_use_cases", "summary": "List use-case tags", "description": "Every use-case tag (usable as the `use_case` filter) with its actuator count.", "tags": [ "taxonomy" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedCountList" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/companies": { "get": { "operationId": "list_companies", "summary": "List supply-chain companies", "description": "Companies along the actuator supply chain (rare earths, magnets and motors, gears and bearings, robot and actuator makers). Filter by country, stage or segment. Every number carries sources, as-of date and confidence. Cursor-paginated.", "tags": [ "supply-chain" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "ISO 3166 alpha-2 country code, e.g. `JP`.", "schema": { "type": "string", "minLength": 2, "maxLength": 2 } }, { "name": "stage", "in": "query", "required": false, "description": "Supply-chain stage, e.g. `magnet`.", "schema": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet", "motor", "gearing", "bearing", "screw", "electronics", "actuator", "robot" ] } }, { "name": "segment", "in": "query", "required": false, "description": "Industry segment.", "schema": { "type": "string", "enum": [ "ree-mining-refining", "magnets-motors", "gears-screws-bearings", "robot-actuator-oem" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Page size, 1 to 100 (default 25).", "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque `pagination.next_cursor`.", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplyChainCompanyList" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/companies/{id}": { "get": { "operationId": "get_company", "summary": "Get one supply-chain company", "description": "One company with its sites, the companies it supplies and the companies that supply it, each with citations.", "tags": [ "supply-chain" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Company id (slug).", "schema": { "type": "string", "examples": [ "jl-mag" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplyChainCompanyDetail" } } } }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/sites": { "get": { "operationId": "list_sites", "summary": "List supply-chain sites", "description": "Headquarters, plants, mines and refineries with coordinates and their precision. Filter by country, stage, company or kind. Cursor-paginated.", "tags": [ "supply-chain" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "ISO 3166 alpha-2 country code, e.g. `JP`.", "schema": { "type": "string", "minLength": 2, "maxLength": 2 } }, { "name": "stage", "in": "query", "required": false, "description": "Supply-chain stage, e.g. `magnet`.", "schema": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet", "motor", "gearing", "bearing", "screw", "electronics", "actuator", "robot" ] } }, { "name": "company", "in": "query", "required": false, "description": "Company id.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "required": false, "description": "Site kind.", "schema": { "type": "string", "enum": [ "hq", "plant", "mine", "refinery", "rnd" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Page size, 1 to 100 (default 25).", "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque `pagination.next_cursor`.", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplyChainSiteList" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/metals": { "get": { "operationId": "list_metals", "summary": "List magnet metals", "description": "The six metals in an actuator's permanent magnet (Nd, Pr, Dy, Tb for NdFeB; Sm, Co for SmCo) with their role and the leading country at each stage: mining, separation, metal and alloy, magnets.", "tags": [ "supply-chain" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetalList" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/metals/{element}": { "get": { "operationId": "get_metal", "summary": "Who supplies one magnet metal", "description": "Country shares of each stage (or one with `stage`), USGS mine production, reserves and years of supply by country, and the latest cited price of every series for the element. Stages no public source splits by country are marked `gap`.", "tags": [ "supply-chain" ], "parameters": [ { "name": "element", "in": "path", "required": true, "description": "Element id: nd, pr, dy, tb, sm or co.", "schema": { "type": "string", "examples": [ "dy" ] } }, { "name": "stage", "in": "query", "required": false, "description": "Only this stage: mining, separation, metal-alloy or magnet.", "schema": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetalSupply" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/metal-prices/{series}": { "get": { "operationId": "get_metal_prices", "summary": "Price history of a magnet metal", "description": "Cited price points for one series in US$/kg (USGS annual averages and year-end ranges, monthly SMM readings in 2026) with the events that touched the element. `from` and `to` take YYYY-MM.", "tags": [ "supply-chain" ], "parameters": [ { "name": "series", "in": "path", "required": true, "description": "Series id, e.g. ndpr-oxide, dy-oxide, tb-metal-cn, tb-metal-fob, co-metal.", "schema": { "type": "string", "examples": [ "dy-oxide" ] } }, { "name": "from", "in": "query", "required": false, "description": "First month, YYYY-MM.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$" } }, { "name": "to", "in": "query", "required": false, "description": "Last month, YYYY-MM.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$" } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetalPrices" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/policy": { "get": { "operationId": "list_policy_measures", "summary": "List policy measures on the actuator chain", "description": "Export controls, tariffs, subsidies and standards that touch the actuator supply chain (mining to robot) in China, the US, the EU, Japan, Korea, Australia and international standards bodies, oldest first. Each measure has its status history with a primary source per change. Filter by jurisdiction, type, stage or status.", "tags": [ "supply-chain" ], "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "ISO 3166 alpha-2 code (CN, US, JP, KR, AU), EU, INTL, or OTHER.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,5}$" } }, { "name": "type", "in": "query", "required": false, "description": "export-control, tariff, subsidy or standard.", "schema": { "type": "string", "enum": [ "export-control", "tariff", "subsidy", "standard" ] } }, { "name": "stage", "in": "query", "required": false, "description": "Supply-chain stage the measure hits, e.g. magnet.", "schema": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet", "motor", "gearing", "bearing", "screw", "electronics", "actuator", "robot" ] } }, { "name": "status", "in": "query", "required": false, "description": "draft, announced, in-force, suspended or expired.", "schema": { "type": "string", "enum": [ "draft", "announced", "in-force", "suspended", "expired" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyMeasureList" } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/policy/{id}": { "get": { "operationId": "get_policy_measure", "summary": "Get one policy measure", "description": "One measure with its issuer, dates, status history, affected stages, HS codes, companies, award size and sources.", "tags": [ "supply-chain" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Measure id, e.g. cn-mofcom-2025-18.", "schema": { "type": "string", "examples": [ "cn-mofcom-2025-18" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyMeasure" } } } }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/humanoids": { "get": { "operationId": "list_humanoids", "summary": "List humanoids with actuator totals", "description": "Every humanoid on /humanoids with its actuator count by type (QDD, planetary, harmonic, cycloidal, roller screw, ball screw, hydraulic, tendon, undisclosed) and estimated NdFeB magnet and rare-earth (Nd, Pr, Dy, Tb) mass, each with a range and confidence.", "tags": [ "robots" ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HumanoidList" } } } }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } }, "/api/v1/humanoids/{id}": { "get": { "operationId": "get_humanoid", "summary": "Get one humanoid joint by joint", "description": "One humanoid mapped onto the canonical joint set: per joint the actuator type and whether it is reported or estimated (with what it was inferred from), motor, reducer, peak torque or force, gear ratio and motor-side torque, estimated magnet mass and sources.", "tags": [ "robots" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Humanoid id (slug).", "schema": { "type": "string", "examples": [ "unitree-g1" ] } } ], "responses": { "200": { "description": "Success.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HumanoidDetail" } } } }, "404": { "$ref": "#/components/responses/Problem404" }, "405": { "$ref": "#/components/responses/Problem405" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" } } } } }, "components": { "schemas": { "Actuator": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable slug, e.g. `robstride-02`." }, "name": { "type": "string" }, "brand": { "type": "string" }, "category": { "type": "string", "enum": [ "qdd_proprioceptive", "integrated_joint", "smart_servo", "harmonic_precision", "frameless_driver", "cycloidal_premium" ] }, "use_cases": { "type": "array", "items": { "type": "string" } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product image URL." }, "product_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer product page." }, "datasheet_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Datasheet URL." }, "price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "List price in USD, when public." }, "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "in_production, discontinued, eol or unknown." }, "peak_torque_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak torque in N·m." }, "rated_torque_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Rated (continuous) torque in N·m." }, "max_speed_rpm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Max output speed in rpm." }, "gear_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Gear ratio, e.g. `9:1`." }, "weight_g": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mass in grams." }, "torque_density_nm_per_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak torque divided by mass." }, "backdrivable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "backlash_arcmin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Backlash in arc-minutes." }, "repeatability_arcmin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Repeatability in arc-minutes." }, "voltage_v": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "null" } ], "description": "Supply voltage (number) or range (string)." }, "peak_current_a": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak current in A." }, "power_w": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Power in W." }, "kt_nm_per_a": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Torque constant in N·m/A." }, "comm": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Bus protocols." }, "control_modes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "encoder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Encoder description." }, "integrated_driver": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "ip_rating": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ingress protection rating." }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text notes." }, "sources": { "type": "array", "items": { "type": "string" }, "description": "Source URLs for the specs." }, "price_per_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "price_usd divided by peak_torque_nm." }, "data_source": { "type": "string" }, "verified": { "type": "boolean", "description": "Specs spot-checked against a source." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer country." }, "country_flag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Flag emoji for country." }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Primary source URL." }, "source_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Domain of source_url." }, "url": { "type": "string", "description": "Human-readable page on actuatorlist.com." }, "api_url": { "type": "string", "description": "Canonical API URL of this resource." } }, "required": [ "id", "name", "brand", "category", "use_cases", "image_url", "product_url", "datasheet_url", "price_usd", "availability", "peak_torque_nm", "rated_torque_nm", "max_speed_rpm", "gear_ratio", "weight_g", "torque_density_nm_per_kg", "backdrivable", "backlash_arcmin", "repeatability_arcmin", "voltage_v", "peak_current_a", "power_w", "kt_nm_per_a", "comm", "control_modes", "encoder", "integrated_driver", "ip_rating", "notes", "sources", "price_per_nm", "data_source", "verified", "country", "country_flag", "source_url", "source_domain", "url", "api_url" ], "additionalProperties": false, "description": "A robot actuator with its published specifications." }, "RobotRef": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "url": { "type": "string" }, "api_url": { "type": "string" } }, "required": [ "id", "name", "brand", "url", "api_url" ], "additionalProperties": false }, "ActuatorDetail": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable slug, e.g. `robstride-02`." }, "name": { "type": "string" }, "brand": { "type": "string" }, "category": { "type": "string", "enum": [ "qdd_proprioceptive", "integrated_joint", "smart_servo", "harmonic_precision", "frameless_driver", "cycloidal_premium" ] }, "use_cases": { "type": "array", "items": { "type": "string" } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product image URL." }, "product_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer product page." }, "datasheet_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Datasheet URL." }, "price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "List price in USD, when public." }, "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "in_production, discontinued, eol or unknown." }, "peak_torque_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak torque in N·m." }, "rated_torque_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Rated (continuous) torque in N·m." }, "max_speed_rpm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Max output speed in rpm." }, "gear_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Gear ratio, e.g. `9:1`." }, "weight_g": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mass in grams." }, "torque_density_nm_per_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak torque divided by mass." }, "backdrivable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "backlash_arcmin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Backlash in arc-minutes." }, "repeatability_arcmin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Repeatability in arc-minutes." }, "voltage_v": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "null" } ], "description": "Supply voltage (number) or range (string)." }, "peak_current_a": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak current in A." }, "power_w": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Power in W." }, "kt_nm_per_a": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Torque constant in N·m/A." }, "comm": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Bus protocols." }, "control_modes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "encoder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Encoder description." }, "integrated_driver": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "ip_rating": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ingress protection rating." }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text notes." }, "sources": { "type": "array", "items": { "type": "string" }, "description": "Source URLs for the specs." }, "price_per_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "price_usd divided by peak_torque_nm." }, "data_source": { "type": "string" }, "verified": { "type": "boolean", "description": "Specs spot-checked against a source." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer country." }, "country_flag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Flag emoji for country." }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Primary source URL." }, "source_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Domain of source_url." }, "url": { "type": "string", "description": "Human-readable page on actuatorlist.com." }, "api_url": { "type": "string", "description": "Canonical API URL of this resource." }, "robots_using": { "type": "array", "items": { "$ref": "#/components/schemas/RobotRef" }, "description": "Robots in the catalog whose joints use this actuator." } }, "required": [ "id", "name", "brand", "category", "use_cases", "image_url", "product_url", "datasheet_url", "price_usd", "availability", "peak_torque_nm", "rated_torque_nm", "max_speed_rpm", "gear_ratio", "weight_g", "torque_density_nm_per_kg", "backdrivable", "backlash_arcmin", "repeatability_arcmin", "voltage_v", "peak_current_a", "power_w", "kt_nm_per_a", "comm", "control_modes", "encoder", "integrated_driver", "ip_rating", "notes", "sources", "price_per_nm", "data_source", "verified", "country", "country_flag", "source_url", "source_domain", "url", "api_url", "robots_using" ], "additionalProperties": false }, "Joint": { "type": "object", "properties": { "role": { "type": "string", "description": "Joint group, e.g. `Shoulder (J1-J3)`." }, "count": { "type": "number", "description": "Number of joints in this group." }, "motor": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "rated_torque_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Rated torque in N·m." }, "peak_torque_nm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Peak torque in N·m." }, "rated_speed_rpm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Rated speed in rpm." }, "gear_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Gear ratio." }, "weight_g": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mass in grams." }, "torque_density_nm_per_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Torque density." }, "product_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product page." }, "actuator_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalog actuator id, when the motor is listed." }, "actuator_api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "API URL of the linked actuator, if any." } }, "required": [ "id", "name", "brand", "rated_torque_nm", "peak_torque_nm", "rated_speed_rpm", "gear_ratio", "weight_g", "torque_density_nm_per_kg", "product_url", "actuator_id", "actuator_api_url" ], "additionalProperties": false } }, "required": [ "role", "count", "motor" ], "additionalProperties": false }, "Robot": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "kind": { "type": "string", "enum": [ "robot_arm", "humanoid" ], "description": "Robot type." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer country." }, "country_flag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Flag emoji." }, "dof": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Degrees of freedom; null when the maker has not published a joint count." }, "payload_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Payload in kg." }, "reach_mm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Reach in mm." }, "height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Standing height in m (humanoids)." }, "weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mass in kg." }, "price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Price (or lower bound) in USD." }, "price_max_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upper price bound in USD, if a range." }, "product_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product page." }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Image URL." }, "summary": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "api_url": { "type": "string" }, "joint_count": { "type": "number" } }, "required": [ "id", "name", "brand", "kind", "country", "country_flag", "dof", "payload_kg", "reach_mm", "height_m", "weight_kg", "price_usd", "price_max_usd", "product_url", "image_url", "summary", "sources", "url", "api_url", "joint_count" ], "additionalProperties": false, "description": "A robot." }, "RobotDetail": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "kind": { "type": "string", "enum": [ "robot_arm", "humanoid" ], "description": "Robot type." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer country." }, "country_flag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Flag emoji." }, "dof": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Degrees of freedom; null when the maker has not published a joint count." }, "payload_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Payload in kg." }, "reach_mm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Reach in mm." }, "height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Standing height in m (humanoids)." }, "weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mass in kg." }, "price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Price (or lower bound) in USD." }, "price_max_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upper price bound in USD, if a range." }, "product_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product page." }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Image URL." }, "summary": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "api_url": { "type": "string" }, "joints": { "type": "array", "items": { "$ref": "#/components/schemas/Joint" } } }, "required": [ "id", "name", "brand", "kind", "country", "country_flag", "dof", "payload_kg", "reach_mm", "height_m", "weight_kg", "price_usd", "price_max_usd", "product_url", "image_url", "summary", "sources", "url", "api_url", "joints" ], "additionalProperties": false }, "Pagination": { "type": "object", "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Opaque cursor for the next page; null on the last page." }, "has_more": { "type": "boolean" }, "total": { "type": "number", "description": "Total matching items across all pages." } }, "required": [ "next_cursor", "has_more", "total" ], "additionalProperties": false }, "ActuatorList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Actuator" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "required": [ "data", "pagination" ], "additionalProperties": false }, "RobotList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Robot" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "required": [ "data", "pagination" ], "additionalProperties": false }, "CompareResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "found": { "type": "boolean" }, "actuator": { "anyOf": [ { "$ref": "#/components/schemas/Actuator" }, { "type": "null" } ] } }, "required": [ "id", "found", "actuator" ], "additionalProperties": false } }, "not_found": { "type": "array", "items": { "type": "string" }, "description": "Requested ids with no match." } }, "required": [ "data", "not_found" ], "additionalProperties": false }, "CategoryList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "enum": [ "qdd_proprioceptive", "integrated_joint", "smart_servo", "harmonic_precision", "frameless_driver", "cycloidal_premium" ] }, "label": { "type": "string" }, "description": { "type": "string" }, "actuator_count": { "type": "number" } }, "required": [ "slug", "label", "description", "actuator_count" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false }, "NamedCountList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "actuator_count": { "type": "number" } }, "required": [ "name", "actuator_count" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false }, "ApiIndex": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "auth": { "type": "string" }, "docs": { "type": "string" }, "openapi": { "type": "string" }, "mcp": { "type": "string" }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string" }, "path": { "type": "string" }, "summary": { "type": "string" } }, "required": [ "method", "path", "summary" ], "additionalProperties": false } } }, "required": [ "name", "version", "description", "auth", "docs", "openapi", "mcp", "endpoints" ], "additionalProperties": false }, "OpenApiDocument": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "An OpenAPI 3.1 document." }, "Problem": { "type": "object", "properties": { "type": { "type": "string", "description": "URI identifying the problem type." }, "title": { "type": "string" }, "status": { "type": "number" }, "detail": { "type": "string" }, "code": { "type": "string", "description": "Stable machine-readable error code." }, "hint": { "description": "How to fix the request.", "type": "string" }, "instance": { "description": "Request path.", "type": "string" }, "docs": { "type": "string", "description": "Documentation link." }, "errors": { "description": "Per-field validation errors.", "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ], "additionalProperties": false } } }, "required": [ "type", "title", "status", "detail", "code", "docs" ], "additionalProperties": false, "description": "RFC 9457 problem details (application/problem+json)." }, "CompareRequest": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Actuator ids to fetch (1 to 20)." } }, "required": [ "ids" ], "additionalProperties": false }, "SourcedNumber": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ] }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Low bound, when the value is a range." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "High bound, when the value is a range." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "as_of": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "Source URLs." } }, "required": [ "value", "unit", "confidence", "low", "high", "note", "as_of", "sources" ], "additionalProperties": false, "description": "A figure with its unit, confidence, range and sources." }, "HumanoidJoint": { "type": "object", "properties": { "canonical": { "type": "string", "description": "Canonical joint, e.g. `l-knee`, `neck`, `r-shoulder-pitch`." }, "count": { "type": "number", "description": "Actuators at this joint node." }, "actuator_type": { "type": "string", "enum": [ "qdd", "planetary", "harmonic", "cycloidal", "linear-roller-screw", "linear-ball-screw", "hydraulic", "tendon", "other" ] }, "type_confidence": { "type": "string", "enum": [ "reported", "estimated" ] }, "inferred_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What an estimated type was inferred from." }, "actuator_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalog actuator id, when listed." }, "motor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reducer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "peak_torque_nm": { "anyOf": [ { "$ref": "#/components/schemas/SourcedNumber" }, { "type": "null" } ] }, "peak_force_n": { "anyOf": [ { "$ref": "#/components/schemas/SourcedNumber" }, { "type": "null" } ] }, "size_class": { "type": "string", "enum": [ "xs", "s", "m", "l", "xl" ], "description": "Motor size class, from motor-side torque." }, "load_class": { "type": "string", "enum": [ "xs", "s", "m", "l", "xl" ], "description": "Joint load class, from output torque or force." }, "motor_sizing": { "anyOf": [ { "type": "object", "properties": { "gear_ratio": { "description": "Reduction n:1, or screw lead in mm for screw actuators. Modeled when the design's typical band stands in.", "$ref": "#/components/schemas/SourcedNumber" }, "efficiency": { "description": "Reducer or screw efficiency, 0 to 1.", "$ref": "#/components/schemas/SourcedNumber" }, "motor_torque_nm": { "description": "Peak torque the motor must make: output / (ratio x efficiency), or force x lead / (2 pi x efficiency).", "$ref": "#/components/schemas/SourcedNumber" } }, "required": [ "gear_ratio", "efficiency", "motor_torque_nm" ], "additionalProperties": false }, { "type": "null" } ], "description": "How the motor behind the joint was sized; null for hydraulics." }, "magnet_mass_g": { "description": "Estimated NdFeB at this node, all actuators.", "$ref": "#/components/schemas/SourcedNumber" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "title", "url" ], "additionalProperties": false } } }, "required": [ "canonical", "count", "actuator_type", "type_confidence", "inferred_from", "actuator_id", "motor", "reducer", "peak_torque_nm", "peak_force_n", "size_class", "load_class", "motor_sizing", "magnet_mass_g", "sources" ], "additionalProperties": false }, "Humanoid": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code, e.g. `CN`." }, "country_name": { "type": "string", "description": "Country name with its flag, e.g. `🇨🇳 China`." }, "robot_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Matching /api/v1/robots id, when there is one." }, "dof": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "actuators": { "type": "number", "description": "Actuators on the canonical joint set." }, "actuator_count_by_type": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "magnet_mass_kg": { "$ref": "#/components/schemas/SourcedNumber" }, "ree_kg": { "type": "object", "properties": { "nd": { "$ref": "#/components/schemas/SourcedNumber" }, "pr": { "$ref": "#/components/schemas/SourcedNumber" }, "dy": { "$ref": "#/components/schemas/SourcedNumber" }, "tb": { "$ref": "#/components/schemas/SourcedNumber" } }, "required": [ "nd", "pr", "dy", "tb" ], "additionalProperties": false }, "actuator_bom_usd": { "type": "number", "description": "Actuator cost total (USD), excluding actuators with no defensible price." }, "page_url": { "type": "string" }, "api_url": { "type": "string" } }, "required": [ "id", "name", "brand", "country", "country_name", "robot_id", "dof", "height_m", "weight_kg", "price_usd", "actuators", "actuator_count_by_type", "magnet_mass_kg", "ree_kg", "actuator_bom_usd", "page_url", "api_url" ], "additionalProperties": false, "description": "A humanoid with its actuator totals." }, "ActuatorBom": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "cost", "mass", "magnet" ] }, "unit": { "type": "string", "description": "`USD` for cost, `kg` for mass and magnet." }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false, "description": "Whole robot where the rest is sourced, else actuators." }, "actuators": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "rest": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, { "type": "null" } ], "description": "Non-actuator parts, null when no source covers them." }, "slices": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Actuator model or design, `Other`, or a non-actuator category." }, "category": { "type": "string", "enum": [ "actuator", "non-actuator" ] }, "lumped": { "type": "boolean", "description": "A non-actuator total the source does not break into categories." }, "actuator_type": { "type": "string", "enum": [ "qdd", "planetary", "harmonic", "cycloidal", "linear-roller-screw", "linear-ball-screw", "hydraulic", "tendon", "other" ] }, "count": { "type": "number" }, "unit_value": { "anyOf": [ { "$ref": "#/components/schemas/SourcedNumber" }, { "type": "null" } ], "description": "Per actuator, with confidence and sources; null for `Other`." }, "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" }, "share": { "type": "number", "description": "Share of the total, 0 to 1." }, "joints": { "type": "array", "items": { "type": "string" } } }, "required": [ "label", "category", "lumped", "actuator_type", "count", "unit_value", "value", "low", "high", "share", "joints" ], "additionalProperties": false } }, "excluded": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "count": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "label", "count", "reason" ], "additionalProperties": false }, "description": "Actuators with no defensible number, left out of the total." }, "price_share": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, { "type": "null" } ], "description": "Actuator cost over the robot's list price, when both exist." } }, "required": [ "metric", "unit", "total", "actuators", "rest", "slices", "excluded", "price_share" ], "additionalProperties": false, "description": "Actuator bill of materials, at most 6 slices plus Other." }, "RareEarthByDesign": { "type": "object", "properties": { "label": { "type": "string", "description": "Actuator design, as in the BOM." }, "actuator_type": { "type": "string", "enum": [ "qdd", "planetary", "harmonic", "cycloidal", "linear-roller-screw", "linear-ball-screw", "hydraulic", "tendon", "other" ] }, "count": { "type": "number" }, "grams": { "type": "object", "properties": { "nd": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "pr": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "dy": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "tb": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false } }, "required": [ "nd", "pr", "dy", "tb" ], "additionalProperties": false, "description": "Grams of each element across all units, estimated." }, "total_grams": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "metal_usd": { "type": "object", "properties": { "nd": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "pr": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "dy": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false }, "tb": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false } }, "required": [ "nd", "pr", "dy", "tb" ], "additionalProperties": false, "description": "Raw metal value (grams x US$/kg), not a magnet price." }, "total_metal_usd": { "type": "object", "properties": { "value": { "type": "number" }, "low": { "type": "number" }, "high": { "type": "number" } }, "required": [ "value", "low", "high" ], "additionalProperties": false } }, "required": [ "label", "actuator_type", "count", "grams", "total_grams", "metal_usd", "total_metal_usd" ], "additionalProperties": false, "description": "Rare earth in one actuator design, from its magnet mass estimate." }, "HumanoidDetail": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code, e.g. `CN`." }, "country_name": { "type": "string", "description": "Country name with its flag, e.g. `🇨🇳 China`." }, "robot_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Matching /api/v1/robots id, when there is one." }, "dof": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "actuators": { "type": "number", "description": "Actuators on the canonical joint set." }, "actuator_count_by_type": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "magnet_mass_kg": { "$ref": "#/components/schemas/SourcedNumber" }, "ree_kg": { "type": "object", "properties": { "nd": { "$ref": "#/components/schemas/SourcedNumber" }, "pr": { "$ref": "#/components/schemas/SourcedNumber" }, "dy": { "$ref": "#/components/schemas/SourcedNumber" }, "tb": { "$ref": "#/components/schemas/SourcedNumber" } }, "required": [ "nd", "pr", "dy", "tb" ], "additionalProperties": false }, "actuator_bom_usd": { "type": "number", "description": "Actuator cost total (USD), excluding actuators with no defensible price." }, "page_url": { "type": "string" }, "api_url": { "type": "string" }, "summary": { "type": "string" }, "not_counted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "joints": { "type": "array", "items": { "$ref": "#/components/schemas/HumanoidJoint" } }, "rare_earth_by_design": { "type": "array", "items": { "$ref": "#/components/schemas/RareEarthByDesign" } }, "rare_earth_metal_price_usd_per_kg": { "type": "object", "properties": { "nd": { "$ref": "#/components/schemas/SourcedNumber" }, "pr": { "$ref": "#/components/schemas/SourcedNumber" }, "dy": { "$ref": "#/components/schemas/SourcedNumber" }, "tb": { "$ref": "#/components/schemas/SourcedNumber" } }, "required": [ "nd", "pr", "dy", "tb" ], "additionalProperties": false, "description": "Metal prices behind metal_usd." }, "bom": { "type": "object", "properties": { "cost": { "$ref": "#/components/schemas/ActuatorBom" }, "mass": { "$ref": "#/components/schemas/ActuatorBom" }, "magnet": { "$ref": "#/components/schemas/ActuatorBom" } }, "required": [ "cost", "mass", "magnet" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "title", "url" ], "additionalProperties": false } } }, "required": [ "id", "name", "brand", "country", "country_name", "robot_id", "dof", "height_m", "weight_kg", "price_usd", "actuators", "actuator_count_by_type", "magnet_mass_kg", "ree_kg", "actuator_bom_usd", "page_url", "api_url", "summary", "not_counted", "joints", "rare_earth_by_design", "rare_earth_metal_price_usd_per_kg", "bom", "sources" ], "additionalProperties": false }, "HumanoidList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Humanoid" } }, "as_of": { "type": "string" } }, "required": [ "data", "as_of" ], "additionalProperties": false }, "MetalList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "nd", "pr", "dy", "tb", "sm", "co" ], "description": "Element id: nd, pr, dy, tb, sm or co." }, "symbol": { "type": "string" }, "name": { "type": "string" }, "class": { "type": "string", "enum": [ "light", "heavy", "transition" ] }, "magnet": { "type": "string", "enum": [ "NdFeB", "SmCo" ] }, "role": { "type": "string", "description": "What the element does in the magnet." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } }, "stages": { "type": "array", "items": { "type": "object", "properties": { "stage": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet" ] }, "top_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "stage", "top_country", "top_share" ], "additionalProperties": false } } }, "required": [ "id", "symbol", "name", "class", "magnet", "role", "sources", "stages" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false }, "MetalSupply": { "type": "object", "properties": { "metal": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "nd", "pr", "dy", "tb", "sm", "co" ], "description": "Element id: nd, pr, dy, tb, sm or co." }, "symbol": { "type": "string" }, "name": { "type": "string" }, "class": { "type": "string", "enum": [ "light", "heavy", "transition" ] }, "magnet": { "type": "string", "enum": [ "NdFeB", "SmCo" ] }, "role": { "type": "string", "description": "What the element does in the magnet." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "id", "symbol", "name", "class", "magnet", "role", "sources" ], "additionalProperties": false }, "stages": { "type": "array", "items": { "type": "object", "properties": { "stage": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet" ] }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "shares", "gap" ], "description": "`gap` when no public source splits this stage by country." }, "shares": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "share": { "type": "number" } }, "required": [ "country", "share" ], "additionalProperties": false }, "description": "Named countries as fractions of world output, largest first." }, "other_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Unattributed remainder." }, "top_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hhi": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Herfindahl-Hirschman index over named countries, 0 to 10,000." }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "string", "enum": [ "reported", "estimated", "modeled" ] }, { "type": "null" } ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method, or what is known for a gap." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "stage", "label", "status", "shares", "other_share", "top_country", "top_share", "hhi", "as_of", "confidence", "note", "sources" ], "additionalProperties": false } }, "reserves": { "type": "object", "properties": { "commodity": { "type": "string", "enum": [ "ree", "co" ] }, "label": { "type": "string" }, "basis": { "type": "string", "description": "`t REO` (rare earth oxide) or `t Co content`." }, "rows": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "ISO 3166 alpha-2 code, or `other`." }, "production_2024": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ] }, "production_2025": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, "reserves": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ], "description": "Null where USGS reports NA." }, "years_of_supply": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ], "description": "Reserves over 2025 mine production, at the current rate." } }, "required": [ "country", "production_2024", "production_2025", "reserves", "years_of_supply" ], "additionalProperties": false } }, "world_production_2025": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, "world_reserves": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." } }, "required": [ "commodity", "label", "basis", "rows", "world_production_2025", "world_reserves" ], "additionalProperties": false, "description": "Rare earths are reported together (REO); cobalt on its own." }, "prices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "element": { "type": "string" }, "form": { "type": "string", "enum": [ "oxide", "metal", "alloy" ] }, "market": { "type": "string", "enum": [ "cn-domestic", "fob-china", "lme" ] }, "market_label": { "type": "string" }, "unit": { "type": "string", "const": "USD/kg" }, "latest": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY for an annual average, YYYY-MM-DD for a reading." }, "basis": { "type": "string", "enum": [ "annual-average", "year-end", "spot" ] }, "price": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." } }, "required": [ "date", "basis", "price" ], "additionalProperties": false } }, "required": [ "id", "label", "element", "form", "market", "market_label", "unit", "latest" ], "additionalProperties": false }, "description": "Latest point of every price series." } }, "required": [ "metal", "stages", "reserves", "prices" ], "additionalProperties": false }, "MetalPrices": { "type": "object", "properties": { "series": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "element": { "type": "string" }, "form": { "type": "string", "enum": [ "oxide", "metal", "alloy" ] }, "market": { "type": "string", "enum": [ "cn-domestic", "fob-china", "lme" ] }, "market_label": { "type": "string" }, "unit": { "type": "string", "const": "USD/kg" } }, "required": [ "id", "label", "element", "form", "market", "market_label", "unit" ], "additionalProperties": false }, "points": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY for an annual average, YYYY-MM-DD for a reading." }, "basis": { "type": "string", "enum": [ "annual-average", "year-end", "spot" ] }, "price": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." } }, "required": [ "date", "basis", "price" ], "additionalProperties": false } }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "supply", "market", "floor" ] }, "elements": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "id", "date", "title", "detail", "kind", "elements", "sources" ], "additionalProperties": false }, "description": "Events that touched this element." } }, "required": [ "series", "points", "events" ], "additionalProperties": false }, "PolicyMeasureList": { "type": "object", "properties": { "as_of": { "type": "string" }, "total": { "type": "number" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyMeasure" } } }, "required": [ "as_of", "total", "results" ], "additionalProperties": false }, "PolicyMeasure": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "description": "Deep link to the measure on /policy." }, "jurisdiction": { "type": "string", "description": "ISO 3166 alpha-2 country code, EU or INTL (standards bodies)." }, "lane": { "type": "string", "enum": [ "CN", "US", "EU", "JP", "KR", "OTHER", "INTL" ], "description": "Swimlane on /policy; OTHER for countries without their own." }, "type": { "type": "string", "enum": [ "export-control", "tariff", "subsidy", "standard" ] }, "type_label": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string", "description": "What the measure does, at most 60 words." }, "issuer": { "type": "string" }, "announced": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "effective": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "draft", "announced", "in-force", "suspended", "expired" ] }, "status_history": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY, YYYY-MM or YYYY-MM-DD." }, "status": { "type": "string", "enum": [ "draft", "announced", "in-force", "suspended", "expired" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "date", "status", "note", "sources" ], "additionalProperties": false }, "description": "Oldest first, each change with its own source." }, "stages": { "type": "array", "items": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet", "motor", "gearing", "bearing", "screw", "electronics", "actuator", "robot" ] }, "description": "Supply-chain stages the measure hits." }, "scope": { "type": "string", "enum": [ "product", "sector", "economy" ], "description": "product, sector or economy." }, "hs_codes": { "type": "array", "items": { "type": "string" } }, "elements": { "type": "array", "items": { "type": "string" } }, "companies_affected": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Supply-chain registry id when the company is in it (GET /api/v1/companies/{id})." } }, "required": [ "name", "company_id" ], "additionalProperties": false } }, "amount_usd": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ], "description": "Award or loan size for subsidies, in US$." }, "metals_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Event pinned on the /metals price chart (/metals?event={id}#prices)." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "id", "url", "jurisdiction", "lane", "type", "type_label", "title", "summary", "issuer", "announced", "effective", "expires", "status", "status_history", "stages", "scope", "hs_codes", "elements", "companies_affected", "amount_usd", "metals_event_id", "sources" ], "additionalProperties": false }, "SupplyChainCompany": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable slug, e.g. `harmonic-drive-systems`." }, "name": { "type": "string" }, "local_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hq_country": { "type": "string", "description": "ISO 3166 alpha-2 code." }, "segment": { "type": "string", "enum": [ "ree-mining-refining", "magnets-motors", "gears-screws-bearings", "robot-actuator-oem" ] }, "stages": { "type": "array", "items": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet", "motor", "gearing", "bearing", "screw", "electronics", "actuator", "robot" ] } }, "ownership": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "ticker", "parent" ], "additionalProperties": false }, { "type": "null" } ] }, "revenue_usd": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ], "description": "Latest fiscal year revenue in USD." }, "gross_margin": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ], "description": "Gross margin as a fraction 0..1." }, "products": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "site_count": { "type": "number" } }, "required": [ "id", "name", "local_name", "hq_country", "segment", "stages", "ownership", "revenue_usd", "gross_margin", "products", "url", "site_count" ], "additionalProperties": false }, "SupplyChainSite": { "type": "object", "properties": { "id": { "type": "string" }, "company_id": { "type": "string" }, "kind": { "type": "string", "enum": [ "hq", "plant", "mine", "refinery", "rnd" ] }, "name": { "type": "string" }, "country": { "type": "string" }, "admin1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Prefecture, province or state." }, "lat": { "type": "number" }, "lon": { "type": "number" }, "precision": { "type": "string", "enum": [ "site", "city", "region" ], "description": "How exact lat/lon is." }, "makes": { "type": "array", "items": { "type": "string" } }, "stages": { "type": "array", "items": { "type": "string", "enum": [ "mining", "separation", "metal-alloy", "magnet", "motor", "gearing", "bearing", "screw", "electronics", "actuator", "robot" ] } }, "capacity": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ] }, "opened": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "range": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, { "type": "null" } ] }, "as_of": { "type": "string", "description": "ISO date, YYYY-MM or YYYY." }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ], "description": "reported, estimated or modeled." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Method for estimated or modeled values." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "value", "unit", "range", "as_of", "confidence", "note", "sources" ], "additionalProperties": false, "description": "A number with its provenance." }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "operating", "construction", "announced", "closed" ] }, { "type": "null" } ] }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "id", "company_id", "kind", "name", "country", "admin1", "lat", "lon", "precision", "makes", "stages", "capacity", "opened", "status", "sources" ], "additionalProperties": false }, "SupplyChainCompanyList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyChainCompany" } }, "pagination": { "type": "object", "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_more": { "type": "boolean" }, "total": { "type": "number" } }, "required": [ "next_cursor", "has_more", "total" ], "additionalProperties": false } }, "required": [ "data", "pagination" ], "additionalProperties": false }, "SupplyChainCompanyDetail": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/SupplyChainCompany" }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyChainSite" } }, "supplies": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "what": { "type": "string" }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ended": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the link stopped (YYYY-MM); null while it is active." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "from", "to", "what", "confidence", "note", "ended", "sources" ], "additionalProperties": false }, "description": "Links where this company is the seller." }, "buys": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "what": { "type": "string" }, "confidence": { "type": "string", "enum": [ "reported", "estimated", "modeled" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ended": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the link stopped (YYYY-MM); null while it is active." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false } } }, "required": [ "from", "to", "what", "confidence", "note", "ended", "sources" ], "additionalProperties": false }, "description": "Links where this company is the buyer." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publisher": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "kind": { "type": "string" }, "accessed": { "type": "string" } }, "required": [ "id", "publisher", "title", "url", "kind", "accessed" ], "additionalProperties": false }, "description": "Citations for profile facts." } }, "required": [ "company", "sites", "supplies", "buys", "sources" ], "additionalProperties": false }, "SupplyChainSiteList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyChainSite" } }, "pagination": { "type": "object", "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_more": { "type": "boolean" }, "total": { "type": "number" } }, "required": [ "next_cursor", "has_more", "total" ], "additionalProperties": false } }, "required": [ "data", "pagination" ], "additionalProperties": false } }, "responses": { "Problem400": { "description": "Problem details; `code` is one of: invalid_parameter, invalid_cursor, invalid_json.", "headers": {}, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem404": { "description": "Problem details; `code` is one of: not_found, unknown_endpoint.", "headers": {}, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem405": { "description": "Problem details; `code` is one of: method_not_allowed.", "headers": { "Allow": { "$ref": "#/components/headers/Allow" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem415": { "description": "Problem details; `code` is one of: unsupported_media_type.", "headers": {}, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem422": { "description": "Problem details; `code` is one of: validation_failed.", "headers": {}, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem429": { "description": "Problem details; `code` is one of: rate_limited.", "headers": { "Retry-After": { "$ref": "#/components/headers/Retry-After" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem500": { "description": "Problem details; `code` is one of: internal_error.", "headers": {}, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "headers": { "API-Version": { "description": "Major API version that served the request.", "schema": { "type": "string" } }, "RateLimit": { "description": "Remaining quota and reset, e.g. `\"default\";r=119;t=42`.", "schema": { "type": "string" } }, "RateLimit-Policy": { "description": "Quota policy: `\"default\";q=120;w=60`.", "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Requests allowed per window.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } }, "Allow": { "description": "Methods supported by this path.", "schema": { "type": "string" } } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Accepted for client compatibility; unnecessary because every operation is read-only and safe to retry.", "schema": { "type": "string", "maxLength": 255 } } }, "securitySchemes": {} }, "x-authentication": { "required": false, "description": "No authentication. All operations are public and read-only." }, "x-rate-limit": { "limit": 120, "window_seconds": 60, "scope": "client IP (first X-Forwarded-For hop)", "headers": [ "RateLimit", "RateLimit-Policy", "X-RateLimit-Limit", "X-RateLimit-Remaining", "X-RateLimit-Reset", "Retry-After" ] }, "x-mcp-server": "https://actuatorlist.com/mcp" }