{ "openapi": "3.1.0", "info": { "title": "Requirements Desk", "version": "1", "description": "Public-data lookups and structured requirement capture. Requests are recorded; nothing is arranged on the requester's behalf." }, "servers": [ { "url": "https://services.forevenza.com" } ], "paths": { "/anything-else/requests": { "post": { "operationId": "anything_else_request", "summary": "Record a requirement: Describe any requirement we do not list", "description": "Your requirement is recorded as you give it. Nothing is arranged, brokered or bought on your behalf and no one is contacted about it. If you leave a contact and we can identify a supplier or a working service, we may reply; a reply is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "category": { "type": "string", "maxLength": 80, "description": "Your own name for the kind of thing you need", "x-facet": "specification" }, "item_or_service": { "type": "string", "maxLength": 200, "description": "The specific item, material or service", "x-facet": "specification" }, "identifiers": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 20, "description": "Part numbers, SKUs, standards, codes", "x-facet": "identifier" }, "constraints": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 20, "description": "Anything that must be true: certifications, grades, delivery terms", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/business-formation/requests": { "post": { "operationId": "business_formation_request", "summary": "Record a requirement: Company formation, registered agents and annual filings", "description": "Your requirement is recorded as written. Nothing is filed with any state, no registered agent is appointed, no EIN is applied for and no one is contacted about your company. If you leave a contact and a filing service or registered agent that fits can be identified, a reply may come; it is not promised. Nothing on this page is legal or tax advice. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "LLC", "C_CORPORATION", "S_CORPORATION_ELECTION", "NONPROFIT_CORPORATION", "LIMITED_PARTNERSHIP", "PROFESSIONAL_ENTITY", "OTHER" ], "description": "The kind of entity", "x-facet": "specification" }, "formation_state": { "type": "string", "maxLength": 60, "description": "State or jurisdiction of formation", "x-facet": "geography" }, "registration_states": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 55, "description": "Other states where the company must register (foreign qualification)", "x-facet": "geography" }, "services_needed": { "type": "array", "items": { "type": "string", "enum": [ "FORMATION_FILING", "REGISTERED_AGENT", "EIN", "OPERATING_AGREEMENT", "ANNUAL_REPORT", "FOREIGN_QUALIFICATION", "REINSTATEMENT", "DISSOLUTION" ] }, "maxItems": 10, "description": "Which filings or services you need", "x-facet": "specification" }, "owners": { "type": "integer", "minimum": 1, "description": "Number of owners or members", "x-facet": "quantity" }, "existing_entity": { "type": "string", "maxLength": 200, "description": "Name or state file number of an existing entity, if the work is on one", "x-facet": "identifier" }, "filing_deadline": { "type": "string", "maxLength": 40, "description": "Date by which the filing or service must be complete (YYYY-MM-DD)", "x-facet": "timing" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/commercial-energy/requests": { "post": { "operationId": "commercial_energy_request", "summary": "Record a requirement: Commercial electricity, gas, solar and EV charging", "description": "The site and its requirement are recorded as given. No supplier, installer or broker is contacted, no contract is offered or arranged, and nothing is priced. Some states, Texas among them, register or license energy brokers, and no such registration is held here. If you leave a contact, a reply may come with public information you can act on yourself; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "need_type": { "type": "string", "enum": [ "ELECTRICITY_SUPPLY", "NATURAL_GAS_SUPPLY", "ONSITE_SOLAR", "BATTERY_STORAGE", "EV_CHARGING", "DEMAND_RESPONSE" ], "description": "What the site needs", "x-facet": "specification" }, "utility_territory": { "type": "string", "maxLength": 120, "description": "Utility or market (for example a distribution utility or ISO zone) and state", "x-facet": "geography" }, "annual_kwh": { "type": "number", "minimum": 0, "description": "Annual electricity use in kWh", "x-facet": "quantity" }, "peak_demand_kw": { "type": "number", "minimum": 0, "description": "Peak demand in kW", "x-facet": "quantity" }, "annual_therms": { "type": "number", "minimum": 0, "description": "Annual gas use in therms", "x-facet": "quantity" }, "contract_term_months": { "type": "integer", "minimum": 1, "description": "Contract term in months", "x-facet": "timing" }, "start_date": { "type": "string", "maxLength": 40, "description": "Date supply or service must start (YYYY-MM-DD)", "x-facet": "timing" }, "chargers": { "type": "integer", "minimum": 0, "description": "Number of charging ports", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/commercial-space/requests": { "post": { "operationId": "commercial_space_request", "summary": "Record a requirement: Warehouse, cold storage, industrial and office space", "description": "The space requirement is recorded as given. No property is offered, shown or leased, no landlord, tenant or broker is contacted, and no one represents you here. Representing a party in a lease for pay is licensed real estate brokerage in Texas, for one, and no such licence is held here. If you leave a contact, a reply may come with public information you can act on yourself; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "space_type": { "type": "string", "enum": [ "WAREHOUSE", "COLD_STORAGE", "FREEZER", "LIGHT_INDUSTRIAL", "MANUFACTURING", "FLEX", "OFFICE", "OUTDOOR_YARD" ], "description": "Type of space", "x-facet": "specification" }, "square_feet": { "type": "integer", "minimum": 1, "description": "Floor area in square feet", "x-facet": "quantity" }, "market": { "type": "string", "maxLength": 160, "description": "City, metro area or radius around a place", "x-facet": "geography" }, "term_months": { "type": "integer", "minimum": 1, "description": "Lease term in months", "x-facet": "timing" }, "start_date": { "type": "string", "maxLength": 40, "description": "Date the space is needed from (YYYY-MM-DD)", "x-facet": "timing" }, "clear_height_ft": { "type": "number", "minimum": 0, "description": "Minimum clear height in feet", "x-facet": "specification" }, "dock_doors": { "type": "integer", "minimum": 0, "description": "Minimum number of dock-high doors", "x-facet": "specification" }, "power": { "type": "string", "maxLength": 80, "description": "Electrical service required (amps, volts, phase)", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/company-financials/requests": { "post": { "operationId": "company_financials_request", "summary": "Record a requirement: Reported financial figures for US public companies", "description": "The call reads SEC EDGAR's XBRL companyconcept API for the CIK or ticker and concept you give, and returns every reported value with its period, form, fiscal year and accession number. Figures are as filed; restatements appear as separate rows.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "company": { "type": "string", "description": "Company name, ticker or CIK", "maxLength": 200, "x-facet": "identifier" }, "metrics": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 20, "description": "Figures needed, e.g. revenue, operating margin, headcount", "x-facet": "specification" }, "periods": { "type": "string", "description": "Fiscal years or quarters", "maxLength": 80, "x-facet": "timing" }, "companies_count": { "type": "integer", "minimum": 1, "description": "How many companies", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/company-financials/op/facts": { "get": { "operationId": "company_financials_facts", "summary": "Every reported value of one XBRL concept for one SEC filer, with period, form and accession number.", "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "SEC CIK" }, { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker" }, { "name": "concept", "in": "query", "required": false, "schema": { "type": "string" }, "description": "XBRL concept name, default Revenues" }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Default us-gaap" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "cik": "0000320193", "entity": "Apple Inc.", "concept": "RevenueFromContractWithCustomerExcludingAssessedTax", "unit": "USD", "values": [ { "start": "2025-09-28", "end": "2026-09-26", "value": 478834000000, "form": "10-K", "fy": 2026, "fp": "FY", "filed": "2026-11-03", "accession": "0000320193-26-000026" } ], "source": "https://data.sec.gov/api/xbrl/companyconcept/CIK0000320193/us-gaap/RevenueFromContractWithCustomerExcludingAssessedTax.json" } } } }, "503": { "description": "Daily budget reached or a source unavailable" } } } }, "/compute-capacity/requests": { "post": { "operationId": "compute_capacity_request", "summary": "Record a requirement: GPU and accelerator capacity by type, count and term", "description": "The configuration and term are recorded as given. No capacity is held, reserved or resold here, no provider is contacted and no account is opened. If you leave a contact and a provider offering that configuration can be identified, a reply may come; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "accelerator": { "type": "string", "maxLength": 80, "description": "Chip and memory, e.g. NVIDIA H100 SXM 80GB", "x-facet": "identifier" }, "accelerator_count": { "type": "integer", "minimum": 1, "description": "Number of accelerators at once", "x-facet": "quantity" }, "gpu_hours": { "type": "number", "minimum": 0, "description": "Total accelerator-hours needed", "x-facet": "quantity" }, "term": { "type": "string", "enum": [ "ON_DEMAND", "SPOT", "RESERVED_1_MONTH", "RESERVED_3_MONTHS", "RESERVED_1_YEAR", "RESERVED_3_YEARS" ], "description": "Commitment", "x-facet": "timing" }, "region": { "type": "string", "maxLength": 120, "description": "Region or countries allowed", "x-facet": "geography" }, "interconnect": { "type": "string", "enum": [ "ANY", "PCIE", "NVLINK_SINGLE_NODE", "INFINIBAND", "ROCE" ], "description": "Interconnect between accelerators and nodes", "x-facet": "specification" }, "start_date": { "type": "string", "maxLength": 40, "description": "When capacity must be available (YYYY-MM-DD)", "x-facet": "timing" }, "deployment": { "type": "string", "enum": [ "BARE_METAL", "VIRTUAL_MACHINE", "KUBERNETES", "SLURM", "MANAGED_JOBS" ], "description": "How the capacity is delivered", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/contract-manufacturing/requests": { "post": { "operationId": "contract_manufacturing_request", "summary": "Record a requirement: Manufacturing quotes: machining, molding, sheet metal and PCB assembly", "description": "Your request for quotation is recorded as described. No drawings are taken, nothing is quoted or ordered, and no shop is sent your part. If you leave a contact and a shop that runs this process at this volume can be identified, a reply may come; it is not promised. Do not send drawings here: confidential or export-controlled designs belong with a shop under your own agreement. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "process": { "type": "string", "enum": [ "CNC_MILLING", "CNC_TURNING", "INJECTION_MOLDING", "SHEET_METAL", "CASTING", "ADDITIVE", "PCB_FABRICATION", "PCB_ASSEMBLY", "OTHER" ], "description": "Manufacturing process", "x-facet": "specification" }, "material": { "type": "string", "maxLength": 120, "description": "Material and grade", "x-facet": "specification" }, "tolerance": { "type": "string", "maxLength": 200, "description": "Tightest tolerances and where they apply", "x-facet": "specification" }, "finish": { "type": "string", "maxLength": 120, "description": "Surface finish or coating", "x-facet": "specification" }, "part_quantity": { "type": "integer", "minimum": 1, "description": "Parts per order", "x-facet": "quantity" }, "lead_time_days": { "type": "integer", "minimum": 1, "description": "Days from order to delivery", "x-facet": "timing" }, "certifications": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 10, "description": "Quality certifications or standards the shop must meet", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/dataset-licensing/requests": { "post": { "operationId": "dataset_licensing_request", "summary": "Record a requirement: Datasets to acquire or license, by domain and coverage", "description": "Your data requirement is recorded as described. No data is supplied, sold or sublicensed, no vendor is contacted and no terms are negotiated. If you leave a contact and a source of that data can be identified, a reply may come; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "domain": { "type": "string", "maxLength": 160, "description": "What the data is about", "x-facet": "specification" }, "fields": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 40, "description": "Fields or attributes required", "x-facet": "specification" }, "coverage": { "type": "string", "maxLength": 200, "description": "Geographic or market coverage", "x-facet": "geography" }, "history_start": { "type": "string", "maxLength": 40, "description": "Earliest date the history must reach (YYYY-MM-DD)", "x-facet": "timing" }, "refresh": { "type": "string", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "REAL_TIME" ], "description": "How often the data must be updated", "x-facet": "timing" }, "intended_use": { "type": "string", "enum": [ "INTERNAL_ANALYSIS", "COMMERCIAL_PRODUCT", "MODEL_TRAINING", "RESEARCH", "REDISTRIBUTION" ], "description": "What the licence must permit", "x-facet": "specification" }, "delivery_format": { "type": "string", "enum": [ "CSV", "PARQUET", "API", "DATABASE_SHARE", "OTHER" ], "description": "How it is delivered", "x-facet": "specification" }, "record_count": { "type": "integer", "minimum": 0, "description": "Approximate number of records or documents", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/document-conversion/requests": { "post": { "operationId": "document_conversion_request", "summary": "Record a requirement: Turn a spreadsheet or PDF into JSON", "description": "You send the file (up to 5 MB) or a public link to it. CSV and XLSX become one JSON object per row under each sheet's header row; a PDF with a text layer becomes its text per page. Scanned PDFs without text are reported as such rather than guessed at. The file is processed in memory and not stored.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "file_type": { "type": "string", "enum": [ "csv", "xlsx", "pdf", "docx", "image", "other" ], "description": "What you have", "x-facet": "specification" }, "target_fields": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 40, "description": "Fields you need out of it", "x-facet": "specification" }, "files": { "type": "integer", "minimum": 1, "description": "How many files", "x-facet": "quantity" }, "pages_per_file": { "type": "integer", "minimum": 1, "description": "Typical pages per file", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/document-conversion/op/convert": { "post": { "operationId": "document_conversion_convert", "summary": "CSV or XLSX to JSON rows per sheet; text PDF to text per page.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "description": "Public link to the file, instead of a raw upload" }, "sheet": { "type": "string", "maxLength": 100, "description": "Only this sheet" } } } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "type": "xlsx", "sheets": [ { "name": "Prices", "header": [ "sku", "description", "unit_price" ], "rows": [ { "sku": "A-100", "description": "Hex bolt M8", "unit_price": 0.12 } ], "row_count": 1, "truncated": false } ] } } } }, "503": { "description": "Daily budget reached or a source unavailable" } } } }, "/entity-verification/requests": { "post": { "operationId": "entity_verification_request", "summary": "Record a requirement: Legal entity verification by name, LEI or CIK", "description": "The lookup runs immediately against GLEIF's public LEI API and, when you give a CIK or ticker, SEC EDGAR's submissions API. The answer lists every matching LEI record with its registration status and the registry it came from. Nothing is inferred: a company with no LEI and no SEC filings returns no match, and the answer says so.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "legal_name": { "type": "string", "description": "The company's name as you have it", "maxLength": 200, "x-facet": "identifier" }, "lei": { "type": "string", "description": "Legal Entity Identifier, 20 characters", "maxLength": 20, "x-facet": "identifier" }, "cik": { "type": "string", "description": "SEC Central Index Key", "maxLength": 10, "x-facet": "identifier" }, "jurisdiction": { "type": "string", "description": "Country or ISO 3166 code where the company is registered", "maxLength": 60, "x-facet": "geography" }, "checks_needed": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 20, "description": "What you need confirmed, e.g. registered address, status, ownership", "x-facet": "specification" }, "volume": { "type": "integer", "description": "How many entities you need verified", "minimum": 1, "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/entity-verification/op/lookup": { "get": { "operationId": "entity_verification_lookup", "summary": "LEI records matching a name or an LEI, and the SEC EDGAR registration for a CIK or ticker, each with its registry source and retrieval time.", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Legal name or part of it" }, { "name": "lei", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A 20-character LEI" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "SEC CIK" }, { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Stock ticker of an SEC filer" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO 3166 alpha-2 code to narrow a name search" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "query": { "name": "Apple Inc.", "ticker": "AAPL" }, "lei_records": [ { "lei": "HWUPKR0MPOU8FGXBT394", "legal_name": "Apple Inc.", "jurisdiction": "US-CA", "entity_status": "ACTIVE", "registration_status": "ISSUED", "next_renewal": "2027-03-08", "legal_address": "C/O C T Corporation System, 330 N. Brand Blvd, Suite 700, Glendale, US-CA, 91203, US", "headquarters_address": "One Apple Park Way, Cupertino, US-CA, 95014, US", "registration_authority": "RA000598", "registration_authority_entity_id": "806592" } ], "edgar": { "cik": "0000320193", "name": "Apple Inc.", "sic": "3571", "sic_description": "Electronic Computers", "state_of_incorporation": "CA", "business_address": "ONE APPLE PARK WAY, CUPERTINO, CA, 95014", "recent_filings": [ { "form": "10-K", "filed": "2026-11-03", "accession": "0000320193-26-000026" } ] }, "sources": [ { "registry": "GLEIF", "url": "https://api.gleif.org/api/v1/lei-records/HWUPKR0MPOU8FGXBT394", "retrieved_at": "2026-11-03T19:05:00Z" }, { "registry": "SEC EDGAR", "url": "https://data.sec.gov/submissions/CIK0000320193.json", "retrieved_at": "2026-11-03T19:05:00Z" } ], "not_found": [] } } } }, "402": { "description": "Payment required: $0.02 via x402 (USDC on eip155:84532)" }, "503": { "description": "Daily budget reached or a source unavailable" } } } }, "/federal-awards/requests": { "post": { "operationId": "federal_awards_request", "summary": "Record a requirement: US federal contract awards by recipient, industry or place", "description": "The call sends your filters to the USAspending.gov award search API and returns the matching contract awards (definitive contracts, purchase orders, delivery and task orders) sorted by amount, with the award identifier and a link to each award's public page. Nothing is estimated.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "recipient": { "type": "string", "maxLength": 200, "description": "Company receiving awards", "x-facet": "identifier" }, "naics": { "type": "string", "maxLength": 6, "description": "NAICS industry code", "x-facet": "identifier" }, "agency": { "type": "string", "maxLength": 120, "description": "Awarding agency", "x-facet": "specification" }, "fiscal_years": { "type": "string", "maxLength": 40, "description": "Fiscal years of interest", "x-facet": "timing" }, "state": { "type": "string", "maxLength": 2, "description": "Place of performance state", "x-facet": "geography" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/federal-awards/op/search": { "get": { "operationId": "federal_awards_search", "summary": "Up to 25 federal contract awards matching recipient, NAICS, state and fiscal year, sorted by amount.", "parameters": [ { "name": "recipient", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Recipient name text" }, { "name": "naics", "in": "query", "required": false, "schema": { "type": "string" }, "description": "NAICS code" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Place of performance state" }, { "name": "fiscal_year", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Federal fiscal year" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "filters": { "recipient": "Booz Allen", "fiscal_year": 2026 }, "awards": [ { "award_id": "36C10B21N10070021", "recipient": "BOOZ ALLEN HAMILTON INC", "amount": 1365285599.63, "agency": "Department of Veterans Affairs", "start_date": "2021-05-17", "naics": "541512", "naics_description": "COMPUTER SYSTEMS DESIGN SERVICES", "url": "https://www.usaspending.gov/award/CONT_AWD_36C10B21N10070021_3600_VA11816D1007_3600" } ], "source": "https://api.usaspending.gov/api/v2/search/spending_by_award/" } } } }, "503": { "description": "Daily budget reached or a source unavailable" } } } }, "/freight-capacity/requests": { "post": { "operationId": "freight_capacity_request", "summary": "Record a requirement: Truckload, LTL and intermodal capacity for a lane", "description": "The lane and the load are recorded exactly as given. No carrier is contacted, nothing is quoted, tendered or booked, and the requirement is not passed to anyone. Arranging motor carrier transportation for pay is brokerage, which requires federal registration, and none is held here. If you leave a contact, a reply may come with public information you can act on yourself; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "origin": { "type": "string", "maxLength": 120, "description": "Pickup city and state, or postal code", "x-facet": "geography" }, "destination": { "type": "string", "maxLength": 120, "description": "Delivery city and state, or postal code", "x-facet": "geography" }, "mode": { "type": "string", "enum": [ "FTL", "LTL", "PARTIAL", "INTERMODAL", "DRAYAGE", "EXPEDITED" ], "description": "How the freight moves", "x-facet": "specification" }, "equipment": { "type": "string", "enum": [ "DRY_VAN", "REEFER", "FLATBED", "STEP_DECK", "CONESTOGA", "TANKER", "CONTAINER", "BOX_TRUCK", "OTHER" ], "description": "Trailer or container type", "x-facet": "specification" }, "weight_lbs": { "type": "number", "minimum": 0, "description": "Total weight in pounds", "x-facet": "quantity" }, "pallets": { "type": "integer", "minimum": 0, "description": "Number of pallets or handling units", "x-facet": "quantity" }, "pickup_window": { "type": "string", "maxLength": 120, "description": "Earliest and latest pickup, with time zone", "x-facet": "timing" }, "hazmat": { "type": "boolean", "description": "Whether the load contains hazardous materials", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/industrial-equipment/requests": { "post": { "operationId": "industrial_equipment_request", "summary": "Record a requirement: Industrial equipment and MRO parts by part number or model", "description": "The part or machine is recorded as identified, with the condition and date you give. No inventory is held here; nothing is sold, reserved or shipped, and no seller is contacted. If you leave a contact and a seller of that exact item can be identified, a reply may come; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "manufacturer": { "type": "string", "maxLength": 120, "description": "Manufacturer or brand", "x-facet": "identifier" }, "part_number": { "type": "string", "maxLength": 80, "description": "Manufacturer part or catalog number", "x-facet": "identifier" }, "model": { "type": "string", "maxLength": 120, "description": "Model or series name", "x-facet": "identifier" }, "condition": { "type": "string", "enum": [ "NEW", "NEW_SURPLUS", "REFURBISHED", "USED", "REPAIR_EXCHANGE", "ANY" ], "description": "Acceptable condition", "x-facet": "specification" }, "units": { "type": "integer", "minimum": 1, "description": "How many", "x-facet": "quantity" }, "needed_by": { "type": "string", "maxLength": 40, "description": "Date it must arrive (YYYY-MM-DD)", "x-facet": "timing" }, "ship_to": { "type": "string", "maxLength": 120, "description": "Delivery city, state or postal code", "x-facet": "geography" }, "documentation": { "type": "array", "items": { "type": "string", "maxLength": 120 }, "maxItems": 10, "description": "Reports, certificates or evidence you require", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/on-site-tasks/requests": { "post": { "operationId": "on_site_tasks_request", "summary": "Record a requirement: Site photos, measurements, inspections and pickups at an address", "description": "The task, place and deadline are recorded as given. No one is sent or hired, and no one is contacted about your task. If you leave a contact and a person or service able to do the task at that place can be identified, a reply may come; it is not promised. Give a business or public address, never a private person's home. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "task_type": { "type": "string", "enum": [ "PHOTOGRAPHS", "MEASUREMENTS", "CONDITION_CHECK", "RETAIL_AUDIT", "DOCUMENT_PICKUP", "PRESENCE_CHECK", "OTHER" ], "description": "Kind of task", "x-facet": "specification" }, "site": { "type": "string", "maxLength": 200, "description": "Business or public address, or a description of the place", "x-facet": "geography" }, "site_type": { "type": "string", "enum": [ "COMMERCIAL", "INDUSTRIAL", "RETAIL", "VACANT_LAND", "PUBLIC_PLACE", "OTHER" ], "description": "Kind of place", "x-facet": "specification" }, "complete_by": { "type": "string", "maxLength": 40, "description": "Date the task must be done (YYYY-MM-DD)", "x-facet": "timing" }, "deliverables": { "type": "array", "items": { "type": "string", "maxLength": 120 }, "maxItems": 15, "description": "What must come back: photos, video, measurements, a signed receipt", "x-facet": "specification" }, "access_arranged": { "type": "boolean", "description": "Whether the site has agreed to the visit", "x-facet": "specification" }, "visits": { "type": "integer", "minimum": 1, "description": "Number of sites or visits", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/public-records/requests": { "post": { "operationId": "public_records_request", "summary": "Record a requirement: Court, property, permit and business records from a named office", "description": "The record and the office that holds it are recorded as described. No request is filed with any court or agency, no fee is paid and no one is contacted about your record. If you leave a contact and the record can be found online, or a retriever who serves that office can be identified, a reply may come; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "record_type": { "type": "string", "enum": [ "COURT_FILING", "DOCKET", "DEED", "MORTGAGE_OR_LIEN", "PLAT_OR_SURVEY", "BUILDING_PERMIT", "BUSINESS_FILING", "UCC_FILING", "OTHER" ], "description": "Kind of record", "x-facet": "specification" }, "jurisdiction": { "type": "string", "maxLength": 120, "description": "County, city, state or federal district", "x-facet": "geography" }, "office": { "type": "string", "maxLength": 160, "description": "Court, recorder, clerk or agency that holds it", "x-facet": "geography" }, "reference_number": { "type": "string", "maxLength": 120, "description": "Case, instrument, book and page, permit or file number", "x-facet": "identifier" }, "party_or_property": { "type": "string", "maxLength": 200, "description": "Business name, parcel number or property description the record concerns", "x-facet": "identifier" }, "date_range": { "type": "string", "maxLength": 80, "description": "Dates the record falls within", "x-facet": "timing" }, "copy_type": { "type": "string", "enum": [ "PLAIN", "CERTIFIED", "EXEMPLIFIED" ], "description": "Kind of copy", "x-facet": "specification" }, "needed_by": { "type": "string", "maxLength": 40, "description": "Date the copy is needed (YYYY-MM-DD)", "x-facet": "timing" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/raw-materials/requests": { "post": { "operationId": "raw_materials_request", "summary": "Record a requirement: Raw materials and commodities by grade and specification", "description": "The material, grade and delivery terms are recorded as given. Nothing is bought, sold, held or shipped for you, no producer or distributor is contacted, and no price is quoted. If you leave a contact and a supplier of that grade can be identified, a reply may come; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "material_class": { "type": "string", "enum": [ "METAL", "POLYMER_RESIN", "CHEMICAL", "INDUSTRIAL_GAS", "MINERAL", "AGRICULTURAL_COMMODITY", "OTHER" ], "description": "Broad class of material", "x-facet": "specification" }, "material": { "type": "string", "maxLength": 160, "description": "The material in your words", "x-facet": "specification" }, "grade_or_standard": { "type": "string", "maxLength": 160, "description": "Grade, alloy, purity or standard (ASTM, ISO, CAS number)", "x-facet": "identifier" }, "form": { "type": "string", "maxLength": 120, "description": "Form and packaging", "x-facet": "specification" }, "volume": { "type": "number", "minimum": 0, "description": "How much", "x-facet": "quantity" }, "volume_unit": { "type": "string", "maxLength": 40, "description": "Unit of the volume (lb, tonnes, gallons, cylinders, per month)", "x-facet": "quantity" }, "delivery_point": { "type": "string", "maxLength": 160, "description": "Where it is delivered", "x-facet": "geography" }, "incoterm": { "type": "string", "enum": [ "EXW", "FCA", "FOB", "CFR", "CIF", "DAP", "DDP", "DELIVERED" ], "description": "Trade terms", "x-facet": "specification" }, "supply_mode": { "type": "string", "enum": [ "cylinder", "dewar", "microbulk", "bulk_tank", "pipeline", "bags_or_drums", "bulk_carrier", "other" ], "description": "How the material is delivered and held: cylinders, microbulk, a bulk tank, drums, bulk carrier", "x-facet": "specification" }, "storage_equipment": { "type": "string", "enum": [ "buyer_owns", "lease_from_supplier", "install_needed", "not_needed" ], "description": "Whether storage (a tank, silo, rack) is already on site or must be leased or installed", "x-facet": "specification" }, "documentation_required": { "type": "array", "items": { "type": "string", "maxLength": 120 }, "maxItems": 10, "description": "Quality documents each delivery must carry, e.g. certificate of analysis, ISBT or FCC grade statement", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/rights-licensing/requests": { "post": { "operationId": "rights_licensing_request", "summary": "Record a requirement: Licensing images, footage, music, fonts or patents", "description": "The work and the use are recorded as described. No licence is granted, sold or negotiated here, no rights holder is contacted, and nothing here says who owns a work. If you leave a contact and a rights holder or licensing agent can be identified, a reply may come; it is not promised. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "work_type": { "type": "string", "enum": [ "PHOTOGRAPH", "FOOTAGE", "MUSIC_COMPOSITION", "SOUND_RECORDING", "FONT", "ILLUSTRATION", "PATENT", "TEXT", "OTHER" ], "description": "Kind of work", "x-facet": "specification" }, "work_identifier": { "type": "string", "maxLength": 200, "description": "Title, ISRC, ISWC, patent number, font name or a link to the work", "x-facet": "identifier" }, "intended_use": { "type": "string", "maxLength": 200, "description": "How the work will be used", "x-facet": "specification" }, "media": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 10, "description": "Media the licence must cover", "x-facet": "specification" }, "territory": { "type": "string", "maxLength": 120, "description": "Countries or regions", "x-facet": "geography" }, "term_months": { "type": "integer", "minimum": 1, "description": "Length of the licence in months", "x-facet": "timing" }, "exclusivity": { "type": "string", "enum": [ "NON_EXCLUSIVE", "EXCLUSIVE", "EXCLUSIVE_IN_FIELD" ], "description": "Exclusivity required", "x-facet": "specification" }, "units": { "type": "integer", "minimum": 0, "description": "Copies, impressions, units or seats covered", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/sanctions-screening/requests": { "post": { "operationId": "sanctions_screening_request", "summary": "Record a requirement: Screen a name against the OFAC SDN list", "description": "The name is normalized and compared with the copy of the SDN list (primary names and aliases) that this service refreshes daily from OFAC. The answer lists matches above the similarity floor with their score, OFAC entry number, type and programs, and the publication the copy came from. A match is a lead to review, not a determination.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "party_name": { "type": "string", "description": "Name to screen", "maxLength": 200, "x-facet": "identifier" }, "party_type": { "type": "string", "enum": [ "individual", "organization", "vessel", "aircraft", "unknown" ], "description": "What the party is", "x-facet": "specification" }, "lists_required": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20, "description": "Which lists you must screen against, e.g. OFAC SDN, EU, UK HMT, UN", "x-facet": "specification" }, "batch_size": { "type": "integer", "minimum": 1, "description": "How many names per run", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/sanctions-screening/op/screen": { "get": { "operationId": "sanctions_screening_screen", "summary": "SDN entries and aliases whose normalized name is similar to the given name, with scores, programs and the list publication date.", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Name to screen" }, { "name": "min_score", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Similarity floor, default 0.82" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "query": "Banco Nacional de Cuba", "matches": [ { "ofac_uid": "306", "listed_name": "BANCO NACIONAL DE CUBA", "score": 1, "type": "organization", "programs": "CUBA", "list": "SDN" } ], "publication": "2026-10-27", "fetched_at": "2026-11-03T06:17:00Z", "note": "A match is a lead for review, not a sanctions determination." } } } }, "503": { "description": "Daily budget reached or a source unavailable" } } } }, "/software-integration/requests": { "post": { "operationId": "software_integration_request", "summary": "Record a requirement: Custom software and API integration work", "description": "The job is recorded as described. No work is done or contracted, no developer or agency is contacted, and no credentials are accepted. If you leave a contact and a developer, or a ready-made connector for those systems, can be identified, a reply may come; it is not promised. Do not send API keys, passwords or customer data. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "systems": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 10, "description": "Systems to connect, by product name", "x-facet": "identifier" }, "data_flow": { "type": "string", "maxLength": 300, "description": "What data moves between them", "x-facet": "specification" }, "direction": { "type": "string", "enum": [ "ONE_WAY", "TWO_WAY" ], "description": "Direction of the flow", "x-facet": "specification" }, "records_per_day": { "type": "integer", "minimum": 0, "description": "Records or transactions a day", "x-facet": "quantity" }, "trigger": { "type": "string", "enum": [ "REAL_TIME", "SCHEDULED_BATCH", "MANUAL" ], "description": "When data moves", "x-facet": "specification" }, "hosting": { "type": "string", "enum": [ "BUYER_CLOUD", "VENDOR_HOSTED", "ON_PREMISES", "NO_PREFERENCE" ], "description": "Where the integration runs", "x-facet": "specification" }, "deadline": { "type": "string", "maxLength": 40, "description": "Date it must be live (YYYY-MM-DD)", "x-facet": "timing" }, "budget_usd": { "type": "number", "minimum": 0, "description": "Budget for the work in US dollars", "x-facet": "budget" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/translation/requests": { "post": { "operationId": "translation_request", "summary": "Record a requirement: Translation and localization by language pair and field", "description": "Your job is recorded as described. No translation is done, no documents are accepted and no translator or agency is contacted. If you leave a contact and a translator or agency working in that pair and field can be identified, a reply may come; it is not promised. Do not send the documents themselves. Contact details are stored apart from the requirement and deleted after 180 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "source_language": { "type": "string", "maxLength": 60, "description": "Language of the original, with locale if it matters", "x-facet": "specification" }, "target_languages": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 30, "description": "Languages to translate into, with locale", "x-facet": "specification" }, "word_count": { "type": "integer", "minimum": 0, "description": "Words in the source", "x-facet": "quantity" }, "pages": { "type": "integer", "minimum": 0, "description": "Pages, for documents counted by page", "x-facet": "quantity" }, "subject_field": { "type": "string", "enum": [ "LEGAL", "MEDICAL", "TECHNICAL", "FINANCIAL", "MARKETING", "SOFTWARE_UI", "LITERARY", "GENERAL" ], "description": "Subject field", "x-facet": "specification" }, "certification": { "type": "string", "enum": [ "NONE", "CERTIFIED", "SWORN_OR_OFFICIAL", "NOTARIZED" ], "description": "Certification required", "x-facet": "specification" }, "deadline": { "type": "string", "maxLength": 40, "description": "Date the translation is due (YYYY-MM-DD)", "x-facet": "timing" }, "file_format": { "type": "string", "maxLength": 80, "description": "Format of the source and of the delivery", "x-facet": "specification" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/web-extraction/requests": { "post": { "operationId": "web_extraction_request", "summary": "Record a requirement: Read a public web page into structured text", "description": "The page is fetched once from the public internet, after its robots.txt is checked for our user agent. Private, internal and this service's own addresses are refused before any request; at most three redirects are followed, each checked again; 5 MB and 10 seconds are the limits. The answer is built from that one response; JavaScript is not run.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "description": "Page to read", "x-facet": "identifier" }, "fields": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 30, "description": "Data you need from the pages, e.g. prices, SKUs, contact", "x-facet": "specification" }, "pages": { "type": "integer", "minimum": 1, "description": "How many pages", "x-facet": "quantity" }, "refresh": { "type": "string", "maxLength": 40, "description": "How often, e.g. daily", "x-facet": "timing" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Recorded; the receipt lists unsupported fields" }, "400": { "description": "Not a valid request" } } } }, "/web-extraction/op/extract": { "post": { "operationId": "web_extraction_extract", "summary": "One public page as title, description, headings, text, links and JSON-LD.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "description": "http or https URL of a public page" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "url": "https://example.com/", "final_url": "https://example.com/", "status": 200, "content_type": "text/html; charset=UTF-8", "title": "Example Domain", "description": null, "canonical": null, "headings": [ { "level": 1, "text": "Example Domain" } ], "text": "Example Domain This domain is for use in documentation examples without needing permission.", "links": [ { "href": "https://iana.org/domains/example", "text": "Learn more" } ], "json_ld": [], "robots": "allowed", "truncated": false } } } }, "503": { "description": "Daily budget reached or a source unavailable" } } } } } }