{ "openapi": "3.1.0", "info": { "title": "Interzoid Batch Data Enrichment API", "summary": "Enrich up to 100 JSON records per call, or entire CSV and TSV files, with AI-powered data in 16 languages, processed in parallel.", "description": "Enrich up to 100 records per call, sent as JSON, or entire CSV and TSV files, with\nreal-time, AI-powered data appended to every record. One API gives access to 39\nenrichment functions: company profiles, parent companies, executives, industry and\nSIC codes, competitors, buying signals, website tech stacks, ESG and government\ncontract profiles, email trust scores, phone and IP profiles, building and property\ndata, sales tax, VAT, per diem, and customs duty rates, name, city, state, and\ncountry standardization, address parsing, translation, and custom fields you define\nat request time.\n\nHigh-performance parallel processing. Every job runs on a pool of 100 concurrent\nworkers, so up to 100 records are enriched at the same time rather than one after\nanother. A full 100-record JSON call takes about as long as its slowest lookup, not\nthe sum of 100 lookups in a row, and files of up to 5,000 records are worked through\n100 records at a time with results streaming back as they complete. For the best\nperformance, send records in batches of up to 100 in one call instead of one call\nper record. No client-side threading, rate limiting, or retry logic is needed.\n\nTwo ways to send records:\n\n1. JSON (recommended for agents and applications). POST up to 100 records to\n `/enrich` as a JSON array of objects, plain values, or row arrays, or as\n `{\"records\": [...]}`, with a 1 MB body limit. Objects come back in order with\n the function's output fields appended after their own fields.\n2. File. GET `/enrich` with `connection` set to the public URL of a CSV or TSV file.\n Up to 5,000 records with an API key, or up to 100 with x402. Results stream back\n as CSV or TSV with the output fields appended as new columns.\n\nChoose the function with the `function` parameter. `GET /functions` returns every\nfunction's inputs with example values, output fields, price per record, and language\nsupport, free and without a key.\n\nMapping records to inputs. Each function has one or more named inputs, usually\n`lookup`. For JSON objects, a field named after an input is used automatically\n(case-insensitive), single-field objects map automatically for single-input\nfunctions, and otherwise `_field` names the field, for example\n`lookup_field=company`. For files and row arrays, `_column` gives the 1-based\ncolumn. `_value` supplies one fixed value for every record. All other fields\npass through unchanged. An output field whose name already exists on a record is\nwritten as `_enriched`.\n\nLanguages. Add `language` to receive enriched values in one of 16 languages:\nfr (French, Français), de (German, Deutsch), it (Italian, Italiano), es (Spanish,\nEspañol), ja (Japanese, 日本語), pt (Portuguese, Português), zh (Mandarin, 中文), ar\n(Arabic, العربية), nl (Dutch, Nederlands), el (Greek, ελληνικά), tr (Turkish,\nTürkçe), ko (Korean, 한국어), sv (Swedish, Svenska), vi (Vietnamese, Tiếng Việt), th\n(Thai, ภาษาไทย), id (Indonesian, Bahasa Indonesia).\nThe value may be the two-letter code, the English name, or the native name, and is\nnot case-sensitive. It is accepted by:\nbuilding-profile, business-info, business-info-domain, business-info-name,\nbuying-signals, company-verification, competitor-analysis, custom,\ncustoms-duty-rates, email-trust-score, esg-profile, eu-vat-rates, executive-profile,\nfacilities-profile, gov-contracts, industry-codes, ip-profile, irs-per-diem-rates,\nmuni-issuer-profile, parent-company, phone-profile, private-company-deal-intel,\nproperty-history, sales-use-tax-rates, sic-codes, stock-analysis, tech-stack,\nuniversity-info, x-handle.\nAn unsupported language, or a function that does not take one, returns English and\nis never an error. The price is the same in every language, output field names do\nnot change, and the `X-Enrich-Language` response header reports the language\napplied.\n\nPricing is per record, by function. Total cost = price per record x number of\nrecords:\n\n- $0.01 per record ($1.00 per 100 records, 1 credit): standardization, translation, parsing, and classification.\n- $0.05 per record ($5.00 per 100 records, 5 credits): X handle lookup.\n- $0.10 per record ($10.00 per 100 records, 10 credits): business name and domain lookup.\n- $0.25 per record ($25.00 per 100 records, 25 credits): business, contact, property, and financial intelligence, plus custom data.\n- $0.35 per record ($35.00 per 100 records, 35 credits): customs duty rates.\n\nTwo payment paths are supported:\n\n1. API key. Pass an Interzoid API key as the `apikey` query parameter or as the\n `x-api-key` request header. Each record draws the function's credits from the\n account balance, and the balance is checked against the whole job before it\n starts.\n2. x402. Send the request with no credentials and the service replies with\n 402 Payment Required and the exact price for the records sent, in USDC on Base.\n Sign the payment authorization and repeat the same request, with the same body,\n adding the PAYMENT-SIGNATURE header. The quote is free, and the settlement\n receipt returns in the PAYMENT-RESPONSE header. See the `x-x402` extension\n objects in this document and the manifest at `/.well-known/x402`.\n\nFailed lookups leave empty output fields and are counted in `ErrorCount`. After 20\nfailed lookups the job stops with a `Code` of Failed. Error responses (400 and 500)\ncarry a plain-text message that says exactly what to change.\n\nMore for agents: the complete guide at https://enrich-api.interzoid.com/llms-full.txt,\nthe MCP server at https://mcp.interzoid.com/mcp (tools `interzoid_enrich_records` and\n`interzoid_enrich_functions`), and the product page with an interactive request\nbuilder at https://www.interzoid.com/apis/batch-data-enrichment. All Interzoid API\ndocumentation: https://docs.interzoid.com.\n", "version": "1.0.0", "termsOfService": "https://www.interzoid.com/api-terms-use", "contact": { "name": "Interzoid Support", "url": "https://www.interzoid.com/contact", "email": "support@interzoid.com" }, "license": { "name": "Interzoid API Terms of Use", "url": "https://www.interzoid.com/api-terms-use" }, "x-x402": { "version": 2, "protocol": "https://x402.org", "discovery": "https://enrich-api.interzoid.com/.well-known/x402", "facilitator": "https://api.cdp.coinbase.com/platform/v2/x402", "networks": [ "eip155:8453" ], "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "payTo": "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566", "price": "0.01 to 0.35 USDC per record, by function (total = price per record x records)", "maxRecords": 100, "concurrency": 100 }, "x-guidance": "Prefer POST /enrich with JSON objects. Send up to 100 records in one call rather than\none call per record: they are processed in parallel, so a batch takes about as long\nas its slowest lookup. Choose the least expensive function whose output fields answer\nthe question. Call without a key to get a free x402 quote before paying.\n" }, "externalDocs": { "description": "Batch Data Enrichment API documentation and interactive request builder", "url": "https://www.interzoid.com/apis/batch-data-enrichment" }, "servers": [ { "url": "https://enrich-api.interzoid.com", "description": "Production" } ], "tags": [ { "name": "Data Enrichment", "description": "Enrich JSON records or CSV and TSV files with any of 39 enrichment functions, up to 100 records in parallel." }, { "name": "Function Catalog", "description": "Free discovery of every function's inputs, outputs, price, and language support." } ], "security": [ { "ApiKeyQuery": [] }, { "ApiKeyHeader": [] }, {} ], "paths": { "/enrich": { "post": { "tags": [ "Data Enrichment" ], "operationId": "enrichRecords", "summary": "Enrich up to 100 JSON records in parallel", "description": "Send up to 100 records in the request body and receive each one back with the\nfunction's output fields appended. JSON in, JSON out by default; set `filetype`\nto csv or tsv to receive delimited text instead.\n\nAll records in the call are processed at the same time, so the call takes about\nas long as its slowest lookup. Batching records this way is much faster than\nsending one call per record.\n\nAll records in a call must have the same shape: all objects, or all plain values\nor row arrays. Objects keep their own fields and field order. Plain values and\nrow arrays come back as `Input` and `Output` pairs.\n\nCost is the function's price per record times the number of records. Calling\nthis operation with no credentials returns 402 Payment Required with the exact\nprice for the records sent. An invalid API key or an insufficient balance returns\n400 with a plain-text message.\n", "x-x402": { "x402Version": 2, "resource": { "url": "https://enrich-api.interzoid.com/enrich", "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json" }, "accepts": [ { "scheme": "exact", "network": "eip155:8453", "amount": "50000", "resource": { "url": "https://enrich-api.interzoid.com/enrich", "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json" }, "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json", "payTo": "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566", "maxTimeoutSeconds": 60, "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "extra": { "name": "USD Coin", "version": "2" } } ] }, "x-payment-info": { "protocols": [ "x402" ], "network": "eip155:8453", "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "payTo": "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566", "mode": "per-record-per-function", "currency": "USD", "maxRecords": 100, "tiers": [ { "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "label": "standardization, translation, parsing, and classification", "functions": [ "address-parse", "city-standard", "country-standard", "email-domain-type", "entity-type", "gender-from-name", "name-origin", "org-standard", "state-standard", "translate" ] }, { "creditsPerRecord": 5, "pricePerRecordUSD": "0.05", "priceFor100RecordsUSD": "5.00", "label": "X handle lookup", "functions": [ "x-handle" ] }, { "creditsPerRecord": 10, "pricePerRecordUSD": "0.10", "priceFor100RecordsUSD": "10.00", "label": "business name and domain lookup", "functions": [ "business-info-domain", "business-info-name" ] }, { "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "label": "business, contact, property, and financial intelligence, plus custom data", "functions": [ "building-profile", "business-info", "buying-signals", "company-verification", "competitor-analysis", "custom", "email-trust-score", "esg-profile", "eu-vat-rates", "executive-profile", "facilities-profile", "gov-contracts", "industry-codes", "ip-profile", "irs-per-diem-rates", "muni-issuer-profile", "parent-company", "phone-profile", "private-company-deal-intel", "property-history", "sales-use-tax-rates", "sic-codes", "stock-analysis", "tech-stack", "university-info" ] }, { "creditsPerRecord": 35, "pricePerRecordUSD": "0.35", "priceFor100RecordsUSD": "35.00", "label": "customs duty rates", "functions": [ "customs-duty-rates" ] } ] }, "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "$ref": "#/components/parameters/Function" }, { "$ref": "#/components/parameters/Language" }, { "$ref": "#/components/parameters/FieldLookup" }, { "$ref": "#/components/parameters/FieldAddress" }, { "$ref": "#/components/parameters/FieldCity" }, { "$ref": "#/components/parameters/FieldCountry" }, { "$ref": "#/components/parameters/FieldEmail" }, { "$ref": "#/components/parameters/FieldHscode" }, { "$ref": "#/components/parameters/FieldName" }, { "$ref": "#/components/parameters/FieldOrg" }, { "$ref": "#/components/parameters/FieldOrigin" }, { "$ref": "#/components/parameters/FieldState" }, { "$ref": "#/components/parameters/FieldText" }, { "$ref": "#/components/parameters/FieldTo" }, { "$ref": "#/components/parameters/ValueLookup" }, { "$ref": "#/components/parameters/ValueAddress" }, { "$ref": "#/components/parameters/ValueCity" }, { "$ref": "#/components/parameters/ValueCountry" }, { "$ref": "#/components/parameters/ValueEmail" }, { "$ref": "#/components/parameters/ValueHscode" }, { "$ref": "#/components/parameters/ValueName" }, { "$ref": "#/components/parameters/ValueOrg" }, { "$ref": "#/components/parameters/ValueOrigin" }, { "$ref": "#/components/parameters/ValueState" }, { "$ref": "#/components/parameters/ValueText" }, { "$ref": "#/components/parameters/ValueTo" }, { "$ref": "#/components/parameters/ColumnLookup" }, { "$ref": "#/components/parameters/ColumnAddress" }, { "$ref": "#/components/parameters/ColumnCity" }, { "$ref": "#/components/parameters/ColumnCountry" }, { "$ref": "#/components/parameters/ColumnEmail" }, { "$ref": "#/components/parameters/ColumnHscode" }, { "$ref": "#/components/parameters/ColumnName" }, { "$ref": "#/components/parameters/ColumnOrg" }, { "$ref": "#/components/parameters/ColumnOrigin" }, { "$ref": "#/components/parameters/ColumnState" }, { "$ref": "#/components/parameters/ColumnText" }, { "$ref": "#/components/parameters/ColumnTo" }, { "$ref": "#/components/parameters/TopicValue" }, { "$ref": "#/components/parameters/OutputFieldsValue" }, { "name": "filetype", "in": "query", "required": false, "description": "Output format for JSON records: json (the default), csv, or tsv.\n", "schema": { "type": "string", "enum": [ "json", "csv", "tsv" ], "default": "json" } } ], "requestBody": { "required": true, "description": "1 to 100 records, as a JSON array or as an object with a `records` array. Every\nrecord must have the same shape.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Records" }, { "$ref": "#/components/schemas/RecordsEnvelope" } ] }, "examples": { "objectsWithLookupField": { "summary": "Objects, naming the lookup field (function=business-info&lookup_field=company)", "value": [ { "crm_id": "A-100", "company": "Cisco" }, { "crm_id": "A-101", "company": "Nvidia" } ] }, "fieldsNamedAfterInputs": { "summary": "Fields named after the inputs map automatically (function=customs-duty-rates)", "value": [ { "sku": "LAPTOP-15", "origin": "China", "lookup": "Germany", "hscode": "8471.30" } ] }, "resultsInGerman": { "summary": "Results in German (function=industry-codes&language=de)", "value": [ { "id": 1, "lookup": "Oracle" }, { "id": 2, "lookup": "Siemens" } ] }, "fieldPlusFixedValue": { "summary": "One field plus a fixed value (function=translate&text_field=notes&to_value=Spanish)", "value": [ { "id": 1, "notes": "Thank you for your order" } ] }, "customFields": { "summary": "Fields you define (function=custom&topic_value=City statistics&output_fields_value=[\"Population\",\"Mayor\"])", "value": [ { "lookup": "Denver" }, { "lookup": "Las Vegas" } ] }, "plainValues": { "summary": "Plain values for a single-input function (function=email-domain-type)", "value": [ "tomj@ibm.com", "x@10minutemail.com" ] }, "rowArrays": { "summary": "Row arrays with a column number (function=org-standard&org_column=2)", "value": [ [ "1001", "B.O.A." ], [ "1002", "intl bus mach" ] ] }, "recordsEnvelope": { "summary": "The same records inside a records envelope", "value": { "records": [ { "company": "IBM" } ] } } } } } }, "responses": { "200": { "description": "Success. Every record comes back with the function's output fields appended.\nA record whose lookup failed keeps empty output fields and is counted in\n`ErrorCount`. If 20 lookups fail, the job stops and the body is an\nEnrichFailure with a `Code` of Failed. On a call paid through x402, the\nresponse also carries the settlement receipt header.\n", "headers": { "X-Enrich-Language": { "$ref": "#/components/headers/X-Enrich-Language" }, "PAYMENT-RESPONSE": { "$ref": "#/components/headers/PAYMENT-RESPONSE" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/EnrichResponse" }, { "$ref": "#/components/schemas/EnrichFailure" } ] }, "examples": { "objectRecords": { "summary": "Objects returned with the output field appended (function=business-info-domain)", "value": { "Code": "Success", "Function": "business-info-domain", "RecordCount": 2, "ErrorCount": 0, "OutputFields": [ "Domain" ], "Records": [ { "id": 7, "company": "IBM", "Domain": "ibm.com" }, { "id": 8, "company": "Microsoft", "Domain": "microsoft.com" } ] } }, "plainValueRecords": { "summary": "Plain values returned as Input and Output pairs (function=email-domain-type)", "value": { "Code": "Success", "Function": "email-domain-type", "RecordCount": 1, "ErrorCount": 0, "OutputFields": [ "DomainType" ], "Records": [ { "Input": [ "tomj@ibm.com" ], "Output": { "DomainType": "Business" } } ] } }, "jobStopped": { "summary": "Job stopped after 20 failed lookups", "value": { "Code": "Failed", "Error": "too many errors", "ErrorCount": 20 } } } }, "text/plain": { "schema": { "type": "string", "description": "CSV or TSV output when `filetype` is csv or tsv." }, "example": "id,company,Domain\n7,IBM,ibm.com\n" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "500": { "$ref": "#/components/responses/ServerError" } } }, "get": { "tags": [ "Data Enrichment" ], "operationId": "enrichFile", "summary": "Enrich a CSV or TSV file in parallel", "description": "Reads a CSV or TSV file from a public URL and streams back every record with the\nfunction's output fields appended as new columns. Up to 5,000 records with an API\nkey, or up to 100 records with x402. Records are processed 100 at a time in\nparallel, and results stream back as they complete.\n\nMap each function input to a column with `_column` (1-based), or give one\nvalue for every record with `_value`. With `has_header=true`, the header\nrow is skipped, never billed, and used to label the output header.\n\nCost is the function's price per record times the number of data records.\nCalling this operation with no credentials returns 402 Payment Required with the\nexact price for the file's records.\n", "x-x402": { "x402Version": 2, "resource": { "url": "https://enrich-api.interzoid.com/enrich", "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json" }, "accepts": [ { "scheme": "exact", "network": "eip155:8453", "amount": "50000", "resource": { "url": "https://enrich-api.interzoid.com/enrich", "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json" }, "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json", "payTo": "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566", "maxTimeoutSeconds": 60, "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "extra": { "name": "USD Coin", "version": "2" } } ] }, "x-payment-info": { "protocols": [ "x402" ], "network": "eip155:8453", "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "payTo": "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566", "mode": "per-record-per-function", "currency": "USD", "maxRecords": 100, "tiers": [ { "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "label": "standardization, translation, parsing, and classification", "functions": [ "address-parse", "city-standard", "country-standard", "email-domain-type", "entity-type", "gender-from-name", "name-origin", "org-standard", "state-standard", "translate" ] }, { "creditsPerRecord": 5, "pricePerRecordUSD": "0.05", "priceFor100RecordsUSD": "5.00", "label": "X handle lookup", "functions": [ "x-handle" ] }, { "creditsPerRecord": 10, "pricePerRecordUSD": "0.10", "priceFor100RecordsUSD": "10.00", "label": "business name and domain lookup", "functions": [ "business-info-domain", "business-info-name" ] }, { "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "label": "business, contact, property, and financial intelligence, plus custom data", "functions": [ "building-profile", "business-info", "buying-signals", "company-verification", "competitor-analysis", "custom", "email-trust-score", "esg-profile", "eu-vat-rates", "executive-profile", "facilities-profile", "gov-contracts", "industry-codes", "ip-profile", "irs-per-diem-rates", "muni-issuer-profile", "parent-company", "phone-profile", "private-company-deal-intel", "property-history", "sales-use-tax-rates", "sic-codes", "stock-analysis", "tech-stack", "university-info" ] }, { "creditsPerRecord": 35, "pricePerRecordUSD": "0.35", "priceFor100RecordsUSD": "35.00", "label": "customs duty rates", "functions": [ "customs-duty-rates" ] } ] }, "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "$ref": "#/components/parameters/Function" }, { "name": "connection", "in": "query", "required": true, "description": "Public URL (http or https) of the input CSV or TSV file.\n", "schema": { "type": "string", "format": "uri" }, "example": "https://dl.interzoid.com/csv/companies.csv" }, { "name": "filetype", "in": "query", "required": true, "description": "Format of the input file, which also sets the output delimiter.\n", "schema": { "type": "string", "enum": [ "csv", "tsv" ] }, "example": "csv" }, { "$ref": "#/components/parameters/ColumnLookup" }, { "$ref": "#/components/parameters/ColumnAddress" }, { "$ref": "#/components/parameters/ColumnCity" }, { "$ref": "#/components/parameters/ColumnCountry" }, { "$ref": "#/components/parameters/ColumnEmail" }, { "$ref": "#/components/parameters/ColumnHscode" }, { "$ref": "#/components/parameters/ColumnName" }, { "$ref": "#/components/parameters/ColumnOrg" }, { "$ref": "#/components/parameters/ColumnOrigin" }, { "$ref": "#/components/parameters/ColumnState" }, { "$ref": "#/components/parameters/ColumnText" }, { "$ref": "#/components/parameters/ColumnTo" }, { "$ref": "#/components/parameters/ValueLookup" }, { "$ref": "#/components/parameters/ValueAddress" }, { "$ref": "#/components/parameters/ValueCity" }, { "$ref": "#/components/parameters/ValueCountry" }, { "$ref": "#/components/parameters/ValueEmail" }, { "$ref": "#/components/parameters/ValueHscode" }, { "$ref": "#/components/parameters/ValueName" }, { "$ref": "#/components/parameters/ValueOrg" }, { "$ref": "#/components/parameters/ValueOrigin" }, { "$ref": "#/components/parameters/ValueState" }, { "$ref": "#/components/parameters/ValueText" }, { "$ref": "#/components/parameters/ValueTo" }, { "name": "has_header", "in": "query", "required": false, "description": "Set to true when the file's first row is a header. The header row is skipped,\nnever billed, and used to label the output header.\n", "schema": { "type": "boolean", "default": false } }, { "name": "include_header", "in": "query", "required": false, "description": "Set to true to write a header row first in the output.\n", "schema": { "type": "boolean", "default": false } }, { "name": "input_headers", "in": "query", "required": false, "description": "JSON array of input column names, used for the output header when the file has\nno header row.\n", "schema": { "type": "string", "contentMediaType": "application/json" }, "example": "[\"company\",\"city\"]" }, { "$ref": "#/components/parameters/Language" }, { "$ref": "#/components/parameters/TopicValue" }, { "$ref": "#/components/parameters/OutputFieldsValue" } ], "responses": { "200": { "description": "Success. The records stream back as CSV or TSV, each with the function's output\nfields appended as new columns. A record whose lookup failed keeps empty output\ncolumns. If 20 lookups fail, the stream ends with the line \"too many errors\".\n", "headers": { "X-Enrich-Language": { "$ref": "#/components/headers/X-Enrich-Language" }, "PAYMENT-RESPONSE": { "$ref": "#/components/headers/PAYMENT-RESPONSE" } }, "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "businessInfoDomain": { "summary": "function=business-info-domain&lookup_column=1&has_header=true&include_header=true", "value": "company,Domain\nIBM,ibm.com\nMicrosoft,microsoft.com\n" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/functions": { "get": { "tags": [ "Function Catalog" ], "operationId": "listFunctions", "summary": "List the enrichment functions", "description": "Returns every enrichment function with its inputs and example values, output\nfields, price per record and per 100 records, price tier, language support, and a\nready-to-run example request. Free, with no API key or payment required. Add\n`name` to return a single function.\n", "security": [], "parameters": [ { "name": "name", "in": "query", "required": false, "description": "Return only this function's catalog entry.\n", "schema": { "$ref": "#/components/schemas/FunctionName" }, "example": "business-info" } ], "responses": { "200": { "description": "Success. The full catalog as an array, or a single entry when `name` is given.\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFunction" } }, { "$ref": "#/components/schemas/CatalogFunction" } ] }, "examples": { "singleFunction": { "summary": "One function (name=email-domain-type)", "value": { "name": "email-domain-type", "description": "Get Email Domain Type - classify email domain (Disposable, Generic, Educational, Business, Government, Unknown)", "product_url": "https://www.interzoid.com/apis/get-email-domain-type", "credits_per_call": 1, "price_per_record_usd": "0.01", "price_for_100_records_usd": "1.00", "price_tier": "standardization, translation, parsing, and classification", "supports_language": false, "input_params": [ { "name": "email", "query_key": "email", "description": "Email address to classify", "example": "tomj@ibm.com", "object_field_param": "email_field", "column_param": "email_column", "value_param": "email_value" } ], "output_fields": [ "DomainType" ], "example": { "method": "POST", "url": "https://enrich-api.interzoid.com/enrich?function=email-domain-type", "body": [ { "id": 1, "email": "tomj@ibm.com" } ], "response_record": { "id": 1, "email": "tomj@ibm.com", "DomainType": "..." }, "note": "Fields named after the inputs are mapped automatically; with other field names, add email_field=." } } } } } } }, "404": { "description": "Not found. The `name` value is not a known function. The body lists the valid\nfunction names.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionNotFound" }, "example": { "error": "unknown function \"nope\"", "functions": [ "address-parse", "building-profile", "business-info" ] } } } } } } } }, "components": { "securitySchemes": { "ApiKeyQuery": { "type": "apiKey", "in": "query", "name": "apikey", "description": "Interzoid API key supplied as a query parameter." }, "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Interzoid API key supplied as a request header." } }, "parameters": { "ApiKey": { "name": "apikey", "in": "query", "required": false, "description": "Interzoid API key. Optional. Omit it to receive an x402 payment challenge\ninstead. May also be supplied as the `x-api-key` header.\n", "schema": { "type": "string" }, "example": "fh5hs7*****" }, "Function": { "name": "function", "in": "query", "required": true, "description": "The enrichment function to apply to every record. `GET /functions` lists each\nfunction's inputs, output fields, and price.\n", "schema": { "$ref": "#/components/schemas/FunctionName" }, "examples": { "companyProfile": { "summary": "Company profile, $0.25 per record", "value": "business-info" }, "companyDomain": { "summary": "Company web domain, $0.10 per record", "value": "business-info-domain" }, "standardizeOrganization": { "summary": "Standardize organization names, $0.01 per record", "value": "org-standard" }, "customsDuty": { "summary": "Customs duty rates, three inputs, $0.35 per record", "value": "customs-duty-rates" }, "customFields": { "summary": "Fields you define, $0.25 per record", "value": "custom" } } }, "Language": { "name": "language", "in": "query", "required": false, "description": "Optional. Return every enriched value in this language, applied to the whole job.\nA two-letter code, English name, or native name, not case-sensitive. Taken by the\npremium functions and `custom`; unsupported languages, and other functions,\nreturn English. The same price applies in every language.\nSee https://docs.interzoid.com/entries/international-language-support\n", "schema": { "$ref": "#/components/schemas/Language" }, "examples": { "code": { "summary": "Two-letter code", "value": "fr" }, "englishName": { "summary": "English name", "value": "German" }, "nativeName": { "summary": "Native name", "value": "Español" } } }, "TopicValue": { "name": "topic_value", "in": "query", "required": false, "description": "Required when `function` is custom. What the data is about.\n", "schema": { "type": "string" }, "example": "City statistics" }, "OutputFieldsValue": { "name": "output_fields_value", "in": "query", "required": false, "description": "Required when `function` is custom. A JSON array of the output field names to\nreturn and append, in order.\n", "schema": { "type": "string", "contentMediaType": "application/json" }, "example": "[\"Population\",\"Mayor\"]" }, "FieldLookup": { "name": "lookup_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `lookup` input. Not needed\nwhen a field is named `lookup` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: business-info, business-info-domain, business-info-name,\nbuying-signals, company-verification, competitor-analysis, custom,\ncustoms-duty-rates, email-trust-score, esg-profile, eu-vat-rates,\nexecutive-profile, facilities-profile, gov-contracts, industry-codes,\nip-profile, irs-per-diem-rates, muni-issuer-profile, parent-company,\nphone-profile, private-company-deal-intel, sales-use-tax-rates, sic-codes,\nstock-analysis, tech-stack, university-info, x-handle.\n", "schema": { "type": "string" }, "example": "company" }, "ColumnLookup": { "name": "lookup_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `lookup` input.\nUsed by: business-info, business-info-domain, business-info-name,\nbuying-signals, company-verification, competitor-analysis, custom,\ncustoms-duty-rates, email-trust-score, esg-profile, eu-vat-rates,\nexecutive-profile, facilities-profile, gov-contracts, industry-codes,\nip-profile, irs-per-diem-rates, muni-issuer-profile, parent-company,\nphone-profile, private-company-deal-intel, sales-use-tax-rates, sic-codes,\nstock-analysis, tech-stack, university-info, x-handle.\n", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, "ValueLookup": { "name": "lookup_value", "in": "query", "required": false, "description": "One fixed value for the `lookup` input, applied to every record.\nUsed by: business-info, business-info-domain, business-info-name,\nbuying-signals, company-verification, competitor-analysis, custom,\ncustoms-duty-rates, email-trust-score, esg-profile, eu-vat-rates,\nexecutive-profile, facilities-profile, gov-contracts, industry-codes,\nip-profile, irs-per-diem-rates, muni-issuer-profile, parent-company,\nphone-profile, private-company-deal-intel, sales-use-tax-rates, sic-codes,\nstock-analysis, tech-stack, university-info, x-handle.\n", "schema": { "type": "string" } }, "FieldAddress": { "name": "address_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `address` input. Not needed\nwhen a field is named `address` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: address-parse, building-profile, property-history.\n", "schema": { "type": "string" } }, "ColumnAddress": { "name": "address_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `address` input.\nUsed by: address-parse, building-profile, property-history.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueAddress": { "name": "address_value", "in": "query", "required": false, "description": "One fixed value for the `address` input, applied to every record.\nUsed by: address-parse, building-profile, property-history.\n", "schema": { "type": "string" } }, "FieldCity": { "name": "city_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `city` input. Not needed\nwhen a field is named `city` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: city-standard.\n", "schema": { "type": "string" } }, "ColumnCity": { "name": "city_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `city` input.\nUsed by: city-standard.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueCity": { "name": "city_value", "in": "query", "required": false, "description": "One fixed value for the `city` input, applied to every record.\nUsed by: city-standard.\n", "schema": { "type": "string" } }, "FieldCountry": { "name": "country_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `country` input. Not needed\nwhen a field is named `country` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: country-standard.\n", "schema": { "type": "string" } }, "ColumnCountry": { "name": "country_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `country` input.\nUsed by: country-standard.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueCountry": { "name": "country_value", "in": "query", "required": false, "description": "One fixed value for the `country` input, applied to every record.\nUsed by: country-standard.\n", "schema": { "type": "string" } }, "FieldEmail": { "name": "email_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `email` input. Not needed\nwhen a field is named `email` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: email-domain-type.\n", "schema": { "type": "string" } }, "ColumnEmail": { "name": "email_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `email` input.\nUsed by: email-domain-type.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueEmail": { "name": "email_value", "in": "query", "required": false, "description": "One fixed value for the `email` input, applied to every record.\nUsed by: email-domain-type.\n", "schema": { "type": "string" } }, "FieldHscode": { "name": "hscode_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `hscode` input. Not needed\nwhen a field is named `hscode` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: customs-duty-rates.\n", "schema": { "type": "string" } }, "ColumnHscode": { "name": "hscode_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `hscode` input.\nUsed by: customs-duty-rates.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueHscode": { "name": "hscode_value", "in": "query", "required": false, "description": "One fixed value for the `hscode` input, applied to every record.\nUsed by: customs-duty-rates.\n", "schema": { "type": "string" } }, "FieldName": { "name": "name_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `name` input. Not needed\nwhen a field is named `name` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: gender-from-name, name-origin.\n", "schema": { "type": "string" } }, "ColumnName": { "name": "name_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `name` input.\nUsed by: gender-from-name, name-origin.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueName": { "name": "name_value", "in": "query", "required": false, "description": "One fixed value for the `name` input, applied to every record.\nUsed by: gender-from-name, name-origin.\n", "schema": { "type": "string" } }, "FieldOrg": { "name": "org_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `org` input. Not needed\nwhen a field is named `org` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: org-standard.\n", "schema": { "type": "string" } }, "ColumnOrg": { "name": "org_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `org` input.\nUsed by: org-standard.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueOrg": { "name": "org_value", "in": "query", "required": false, "description": "One fixed value for the `org` input, applied to every record.\nUsed by: org-standard.\n", "schema": { "type": "string" } }, "FieldOrigin": { "name": "origin_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `origin` input. Not needed\nwhen a field is named `origin` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: customs-duty-rates.\n", "schema": { "type": "string" } }, "ColumnOrigin": { "name": "origin_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `origin` input.\nUsed by: customs-duty-rates.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueOrigin": { "name": "origin_value", "in": "query", "required": false, "description": "One fixed value for the `origin` input, applied to every record.\nUsed by: customs-duty-rates.\n", "schema": { "type": "string" } }, "FieldState": { "name": "state_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `state` input. Not needed\nwhen a field is named `state` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: state-standard.\n", "schema": { "type": "string" } }, "ColumnState": { "name": "state_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `state` input.\nUsed by: state-standard.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueState": { "name": "state_value", "in": "query", "required": false, "description": "One fixed value for the `state` input, applied to every record.\nUsed by: state-standard.\n", "schema": { "type": "string" } }, "FieldText": { "name": "text_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `text` input. Not needed\nwhen a field is named `text` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: entity-type, translate.\n", "schema": { "type": "string" } }, "ColumnText": { "name": "text_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `text` input.\nUsed by: entity-type, translate.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueText": { "name": "text_value", "in": "query", "required": false, "description": "One fixed value for the `text` input, applied to every record.\nUsed by: entity-type, translate.\n", "schema": { "type": "string" } }, "FieldTo": { "name": "to_field", "in": "query", "required": false, "description": "JSON objects only. The record field that holds the `to` input. Not needed\nwhen a field is named `to` (case-insensitive), or when each object has one\nfield and the function has one input.\nUsed by: translate.\n", "schema": { "type": "string" } }, "ColumnTo": { "name": "to_column", "in": "query", "required": false, "description": "Files and JSON row arrays. The 1-based column that holds the `to` input.\nUsed by: translate.\n", "schema": { "type": "integer", "minimum": 1 } }, "ValueTo": { "name": "to_value", "in": "query", "required": false, "description": "One fixed value for the `to` input, applied to every record.\nUsed by: translate.\n", "schema": { "type": "string" }, "example": "Spanish" } }, "schemas": { "FunctionName": { "type": "string", "title": "FunctionName", "description": "An enrichment function name. `custom` also requires `topic_value` and\n`output_fields_value`. Prices and inputs are listed in `x-enrich-functions` and\nby `GET /functions`.\n", "enum": [ "address-parse", "building-profile", "business-info", "business-info-domain", "business-info-name", "buying-signals", "city-standard", "company-verification", "competitor-analysis", "country-standard", "custom", "customs-duty-rates", "email-domain-type", "email-trust-score", "entity-type", "esg-profile", "eu-vat-rates", "executive-profile", "facilities-profile", "gender-from-name", "gov-contracts", "industry-codes", "ip-profile", "irs-per-diem-rates", "muni-issuer-profile", "name-origin", "org-standard", "parent-company", "phone-profile", "private-company-deal-intel", "property-history", "sales-use-tax-rates", "sic-codes", "state-standard", "stock-analysis", "tech-stack", "translate", "university-info", "x-handle" ] }, "Language": { "type": "string", "title": "Language", "maxLength": 40, "description": "One of the 16 supported languages, as a two-letter code, English name, or native\nname:\nfr (French, Français), de (German, Deutsch), it (Italian, Italiano), es (Spanish,\nEspañol), ja (Japanese, 日本語), pt (Portuguese, Português), zh (Mandarin, 中文), ar\n(Arabic, العربية), nl (Dutch, Nederlands), el (Greek, ελληνικά), tr (Turkish,\nTürkçe), ko (Korean, 한국어), sv (Swedish, Svenska), vi (Vietnamese, Tiếng Việt), th\n(Thai, ภาษาไทย), id (Indonesian, Bahasa Indonesia).\n", "examples": [ "fr", "de", "it", "es", "ja", "pt", "zh", "ar", "nl", "el", "tr", "ko", "sv", "vi", "th", "id" ] }, "Scalar": { "title": "Scalar", "description": "A single JSON value.", "type": [ "string", "number", "boolean", "null" ] }, "JsonRecord": { "type": "object", "title": "JsonRecord", "description": "A record with named fields. Fields named after the function's inputs map\nautomatically. All other fields pass through unchanged.\n", "minProperties": 1, "additionalProperties": true, "examples": [ { "id": 1, "company": "Cisco" } ] }, "RowRecord": { "type": "array", "title": "RowRecord", "description": "A row of values. Map inputs to positions with `_column`.", "minItems": 1, "items": { "$ref": "#/components/schemas/Scalar" } }, "Records": { "type": "array", "title": "Records", "description": "1 to 100 records, all of the same shape.", "minItems": 1, "maxItems": 100, "items": { "oneOf": [ { "$ref": "#/components/schemas/JsonRecord" }, { "$ref": "#/components/schemas/Scalar" }, { "$ref": "#/components/schemas/RowRecord" } ] } }, "RecordsEnvelope": { "type": "object", "title": "RecordsEnvelope", "description": "The records inside an object, as an alternative to a bare array.", "required": [ "records" ], "properties": { "records": { "$ref": "#/components/schemas/Records" } }, "additionalProperties": false }, "EnrichResponse": { "type": "object", "title": "EnrichResponse", "description": "The enriched records plus job status and counts.", "required": [ "Code", "Function", "RecordCount", "ErrorCount", "OutputFields", "Records" ], "properties": { "Code": { "type": "string", "description": "Status of the job.", "examples": [ "Success" ] }, "Function": { "$ref": "#/components/schemas/FunctionName" }, "RequestedLanguage": { "type": "string", "description": "The language sent to the enrichment function, when one was applied.", "examples": [ "de" ] }, "RecordCount": { "type": "integer", "description": "Number of records processed.", "examples": [ 2 ] }, "ErrorCount": { "type": "integer", "description": "Number of records whose lookup failed. Their output fields are empty.", "examples": [ 0 ] }, "InputHeaders": { "type": "array", "description": "Input column names, when known.", "items": { "type": "string" } }, "OutputFields": { "type": "array", "description": "The output field names appended to each record, in order.", "items": { "type": "string" }, "examples": [ [ "Domain" ] ] }, "Records": { "type": "array", "description": "Objects for object input, each with its own fields followed by the output\nfields. Input and Output pairs for plain values and row arrays.\n", "items": { "oneOf": [ { "$ref": "#/components/schemas/EnrichedRecord" }, { "$ref": "#/components/schemas/InputOutputRecord" } ] } } } }, "EnrichedRecord": { "type": "object", "title": "EnrichedRecord", "description": "An input object with the function's output fields appended after its own fields.\nThe appended fields for each function are described by the schemas named\n`Output`, for example BusinessInfoOutput.\n", "additionalProperties": true }, "InputOutputRecord": { "type": "object", "title": "InputOutputRecord", "description": "A plain value or row array with its enriched output.", "required": [ "Input", "Output" ], "properties": { "Input": { "type": "array", "description": "The record's input values.", "items": { "type": "string" } }, "Output": { "type": "object", "description": "Output field name to value.", "additionalProperties": { "type": "string" } } } }, "EnrichFailure": { "type": "object", "title": "EnrichFailure", "description": "Returned when the job stops after 20 failed lookups.", "required": [ "Code", "Error" ], "properties": { "Code": { "type": "string", "description": "Status of the job.", "examples": [ "Failed" ] }, "Error": { "type": "string", "description": "Why the job stopped.", "examples": [ "too many errors" ] }, "ErrorCount": { "type": "integer", "description": "Number of failed lookups.", "examples": [ 20 ] } } }, "CatalogFunction": { "type": "object", "title": "CatalogFunction", "description": "One enrichment function, as returned by `GET /functions`.", "properties": { "name": { "$ref": "#/components/schemas/FunctionName" }, "description": { "type": "string", "description": "What the function returns." }, "product_url": { "type": "string", "format": "uri", "description": "Documentation for the underlying API." }, "credits_per_call": { "type": "integer", "description": "Credits used per record with an API key." }, "price_per_record_usd": { "type": "string", "description": "Price per record in USD.", "examples": [ "0.25" ] }, "price_for_100_records_usd": { "type": "string", "description": "Price for 100 records in USD.", "examples": [ "25.00" ] }, "price_tier": { "type": "string", "description": "Plain-English name of the price tier." }, "supports_language": { "type": "boolean", "description": "True when the function accepts `language`." }, "input_params": { "type": "array", "description": "The function's inputs and the parameters that map each one.", "items": { "$ref": "#/components/schemas/CatalogInput" } }, "required_query_params": { "type": "array", "description": "Parameters the function requires beyond its inputs (for `custom`, topic_value and output_fields_value).", "items": { "type": "object", "additionalProperties": true } }, "optional_params": { "type": "array", "description": "Optional parameters the function accepts, such as language.", "items": { "type": "object", "additionalProperties": true } }, "output_fields": { "type": "array", "description": "The output fields appended to each record, in order.", "items": { "type": "string" } }, "output_fields_note": { "type": "string", "description": "Notes on the output fields (for `custom`, that you define them)." }, "example": { "type": "object", "description": "A ready-to-run request (method, url, body) and the shape of a returned record.", "additionalProperties": true } }, "additionalProperties": true }, "CatalogInput": { "type": "object", "title": "CatalogInput", "description": "One function input.", "properties": { "name": { "type": "string", "description": "The input name.", "examples": [ "lookup" ] }, "query_key": { "type": "string", "description": "The input name as used in parameter names." }, "description": { "type": "string", "description": "What the input holds." }, "example": { "type": "string", "description": "An example value." }, "object_field_param": { "type": "string", "description": "The parameter that maps a JSON object field to this input.", "examples": [ "lookup_field" ] }, "column_param": { "type": "string", "description": "The parameter that maps a column to this input.", "examples": [ "lookup_column" ] }, "value_param": { "type": "string", "description": "The parameter that gives this input one fixed value.", "examples": [ "lookup_value" ] } } }, "FunctionNotFound": { "type": "object", "title": "FunctionNotFound", "description": "Returned by `GET /functions` for an unknown function name.", "properties": { "error": { "type": "string", "description": "What went wrong." }, "functions": { "type": "array", "description": "The valid function names.", "items": { "type": "string" } } } }, "AddressParseOutput": { "type": "object", "title": "AddressParseOutput", "description": "Fields appended to each record by `address-parse` (Address Parse). $0.01 per record.", "properties": { "StreetNumber": { "type": "string" }, "PreDirection": { "type": "string" }, "StreetName": { "type": "string" }, "StreetSuffix": { "type": "string" }, "PostDirection": { "type": "string" }, "UnitType": { "type": "string" }, "UnitNumber": { "type": "string" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" }, "Special": { "type": "string" }, "BuildingName": { "type": "string" }, "Organization": { "type": "string" }, "AdditionalInformation": { "type": "string" } } }, "BuildingProfileOutput": { "type": "object", "title": "BuildingProfileOutput", "description": "Fields appended to each record by `building-profile` (Building Profile). $0.25 per record.", "properties": { "PropertyAddress": { "type": "string" }, "BuildingClass": { "type": "string" }, "YearBuilt": { "type": "string" }, "TotalSquareFootage": { "type": "string" }, "FloorCount": { "type": "string" }, "PrimaryTenants": { "type": "string" }, "PropertyManager": { "type": "string" }, "OwnershipEntity": { "type": "string" }, "RecentRenovations": { "type": "string" }, "ParkingRatio": { "type": "string" }, "TransitAccess": { "type": "string" }, "BuildingReferenceURL": { "type": "string" } } }, "BusinessInfoDomainOutput": { "type": "object", "title": "BusinessInfoDomainOutput", "description": "Fields appended to each record by `business-info-domain` (Business Info Domain). $0.10 per record.", "properties": { "Domain": { "type": "string" } } }, "BusinessInfoNameOutput": { "type": "object", "title": "BusinessInfoNameOutput", "description": "Fields appended to each record by `business-info-name` (Business Info Name). $0.10 per record.", "properties": { "CompanyName": { "type": "string" } } }, "BusinessInfoOutput": { "type": "object", "title": "BusinessInfoOutput", "description": "Fields appended to each record by `business-info` (Business Info). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "CompanyURL": { "type": "string" }, "CompanyLocation": { "type": "string" }, "CompanyDescription": { "type": "string" }, "Revenue": { "type": "string" }, "NumberEmployees": { "type": "string" }, "NAICS": { "type": "string" }, "TopExecutive": { "type": "string" }, "TopExecutiveTitle": { "type": "string" } } }, "BuyingSignalsOutput": { "type": "object", "title": "BuyingSignalsOutput", "description": "Fields appended to each record by `buying-signals` (Buying Signals). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "Industry": { "type": "string" }, "CompanySize": { "type": "string" }, "LeadershipChanges": { "type": "string" }, "FundingEvents": { "type": "string" }, "HiringSignals": { "type": "string" }, "TechnologyShifts": { "type": "string" }, "StrategicInitiatives": { "type": "string" }, "SignalStrengthScore": { "type": "string" }, "RecommendedTiming": { "type": "string" }, "DecisionMakerTitles": { "type": "string" } } }, "CityStandardOutput": { "type": "object", "title": "CityStandardOutput", "description": "Fields appended to each record by `city-standard` (Standardize City Name). $0.01 per record.", "properties": { "CityStandard": { "type": "string" } } }, "CompanyVerificationOutput": { "type": "object", "title": "CompanyVerificationOutput", "description": "Fields appended to each record by `company-verification` (Company Verification). $0.25 per record.", "properties": { "Score": { "type": "string" }, "Reasoning": { "type": "string" } } }, "CompetitorAnalysisOutput": { "type": "object", "title": "CompetitorAnalysisOutput", "description": "Fields appended to each record by `competitor-analysis` (Competitor Analysis). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "Industry": { "type": "string" }, "MarketPosition": { "type": "string" }, "TopCompetitors": { "type": "string" }, "IndirectCompetitors": { "type": "string" }, "CompetitiveAdvantages": { "type": "string" }, "CompetitiveWeaknesses": { "type": "string" }, "MarketDynamics": { "type": "string" }, "StrategicOutlook": { "type": "string" } } }, "CountryStandardOutput": { "type": "object", "title": "CountryStandardOutput", "description": "Fields appended to each record by `country-standard` (Standardize Country Name). $0.01 per record.", "properties": { "CountryStandard": { "type": "string" } } }, "CustomOutput": { "type": "object", "title": "CustomOutput", "description": "Fields appended to each record by `custom`: the names listed in `output_fields_value`, in that order. $0.25 per record.", "additionalProperties": { "type": "string" } }, "CustomsDutyRatesOutput": { "type": "object", "title": "CustomsDutyRatesOutput", "description": "Fields appended to each record by `customs-duty-rates` (Customs Duty Rates). $0.35 per record.", "properties": { "OriginCountry": { "type": "string" }, "DestinationCountry": { "type": "string" }, "CountryCodeISO2": { "type": "string" }, "HSCode": { "type": "string" }, "HSCodeDescription": { "type": "string" }, "MFNAppliedRate": { "type": "string" }, "DutyBasis": { "type": "string" }, "ApplicablePreferentialRate": { "type": "string" }, "TradeRemedyDuties": { "type": "string" }, "SafeguardMeasures": { "type": "string" }, "ImportVATOrGST": { "type": "string" }, "SpecialOrAdditionalTaxes": { "type": "string" }, "DeMinimisThreshold": { "type": "string" }, "RestrictionsNotes": { "type": "string" }, "EffectivePeriod": { "type": "string" }, "CustomsAuthorityReferenceURL": { "type": "string" } } }, "EmailDomainTypeOutput": { "type": "object", "title": "EmailDomainTypeOutput", "description": "Fields appended to each record by `email-domain-type` (Email Domain Type). $0.01 per record.", "properties": { "DomainType": { "type": "string" } } }, "EmailTrustScoreOutput": { "type": "object", "title": "EmailTrustScoreOutput", "description": "Fields appended to each record by `email-trust-score` (Email Trust Score). $0.25 per record.", "properties": { "Email": { "type": "string" }, "Score": { "type": "string" }, "Reasoning": { "type": "string" } } }, "EntityTypeOutput": { "type": "object", "title": "EntityTypeOutput", "description": "Fields appended to each record by `entity-type` (Determine Entity Type). $0.01 per record.", "properties": { "Result": { "type": "string" } } }, "EsgProfileOutput": { "type": "object", "title": "EsgProfileOutput", "description": "Fields appended to each record by `esg-profile` (ESG & Sustainability Profile). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "CompanyURL": { "type": "string" }, "ESGRiskRating": { "type": "string" }, "EnvironmentalScore": { "type": "string" }, "SocialScore": { "type": "string" }, "GovernanceScore": { "type": "string" }, "CarbonEmissionsScopes": { "type": "string" }, "NetZeroTarget": { "type": "string" }, "RenewableEnergyPercent": { "type": "string" }, "ESGControversies": { "type": "string" }, "SustainabilityFrameworks": { "type": "string" }, "ESGReferenceURL": { "type": "string" } } }, "EuVatRatesOutput": { "type": "object", "title": "EuVatRatesOutput", "description": "Fields appended to each record by `eu-vat-rates` (European VAT Rates). $0.25 per record.", "properties": { "CountryName": { "type": "string" }, "CountryCodeISO2": { "type": "string" }, "TaxSystem": { "type": "string" }, "TaxSystemLocalName": { "type": "string" }, "StandardRate": { "type": "string" }, "ReducedRates": { "type": "string" }, "SuperReducedRate": { "type": "string" }, "ZeroRatedCategories": { "type": "string" }, "ExemptCategories": { "type": "string" }, "TerritorialExceptions": { "type": "string" }, "EUMemberStatus": { "type": "string" }, "RegistrationThreshold": { "type": "string" }, "TaxAuthorityReferenceURL": { "type": "string" } } }, "ExecutiveProfileOutput": { "type": "object", "title": "ExecutiveProfileOutput", "description": "Fields appended to each record by `executive-profile` (Executive Profile). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "CompanyURL": { "type": "string" }, "ExecutiveName": { "type": "string" }, "ExecutiveTitle": { "type": "string" }, "LinkedInURL": { "type": "string" }, "BiographyURL": { "type": "string" } } }, "FacilitiesProfileOutput": { "type": "object", "title": "FacilitiesProfileOutput", "description": "Fields appended to each record by `facilities-profile` (Corporate Facilities Profile). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "CompanyURL": { "type": "string" }, "HeadquartersLocation": { "type": "string" }, "TotalFacilityCount": { "type": "string" }, "TotalSquareFootage": { "type": "string" }, "OwnedLeasedMix": { "type": "string" }, "FacilityTypeBreakdown": { "type": "string" }, "TopGeographicMarkets": { "type": "string" }, "RecentOpenings": { "type": "string" }, "RecentClosures": { "type": "string" }, "WorkPolicy": { "type": "string" }, "FacilitiesReferenceURL": { "type": "string" } } }, "GenderFromNameOutput": { "type": "object", "title": "GenderFromNameOutput", "description": "Fields appended to each record by `gender-from-name` (Determine Gender from Name). $0.01 per record.", "properties": { "Gender": { "type": "string" } } }, "GovContractsOutput": { "type": "object", "title": "GovContractsOutput", "description": "Fields appended to each record by `gov-contracts` (Government Contracts). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "CompanyURL": { "type": "string" }, "LifetimeContractValue": { "type": "string" }, "TTMContractValue": { "type": "string" }, "TopAwardingAgencies": { "type": "string" }, "ActiveContractVehicles": { "type": "string" }, "SetAsideStatus": { "type": "string" }, "RecentMajorAwards": { "type": "string" }, "PrimeSubMix": { "type": "string" }, "TopNAICSCodes": { "type": "string" }, "CAGECode": { "type": "string" }, "SAMReferenceURL": { "type": "string" } } }, "IndustryCodesOutput": { "type": "object", "title": "IndustryCodesOutput", "description": "Fields appended to each record by `industry-codes` (Industry Codes). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "PrimaryIndustry": { "type": "string" }, "NAICSCode": { "type": "string" }, "NAICSCodeTitle": { "type": "string" }, "SICCode": { "type": "string" }, "SICCodeTitle": { "type": "string" }, "Sector": { "type": "string" }, "Subsector": { "type": "string" }, "IndustryDefinition": { "type": "string" }, "ConfidenceScore": { "type": "string" } } }, "IpProfileOutput": { "type": "object", "title": "IpProfileOutput", "description": "Fields appended to each record by `ip-profile` (IP Address Profile). $0.25 per record.", "properties": { "Version": { "type": "string" }, "ASN": { "type": "string" }, "Organization": { "type": "string" }, "CIDR": { "type": "string" }, "Hostname": { "type": "string" }, "Geolocation": { "type": "string" }, "AbuseContact": { "type": "string" }, "Reputation": { "type": "string" } } }, "IrsPerDiemRatesOutput": { "type": "object", "title": "IrsPerDiemRatesOutput", "description": "Fields appended to each record by `irs-per-diem-rates` (IRS Per Diem Rates). $0.25 per record.", "properties": { "Jurisdiction": { "type": "string" }, "JurisdictionLevel": { "type": "string" }, "LookupType": { "type": "string" }, "State": { "type": "string" }, "County": { "type": "string" }, "City": { "type": "string" }, "IRSClassification": { "type": "string" }, "TotalPerDiem": { "type": "string" }, "LodgingAllowance": { "type": "string" }, "MealsIncidentalAllowance": { "type": "string" }, "IncidentalExpensesOnlyRate": { "type": "string" }, "EffectivePeriod": { "type": "string" }, "IRSReferenceURL": { "type": "string" } } }, "MuniIssuerProfileOutput": { "type": "object", "title": "MuniIssuerProfileOutput", "description": "Fields appended to each record by `muni-issuer-profile` (Municipal Issuer Profile). $0.25 per record.", "properties": { "IssuerName": { "type": "string" }, "IssuerType": { "type": "string" }, "State": { "type": "string" }, "Population": { "type": "string" }, "IssuerProfile": { "type": "string" }, "TypicalSecurityTypes": { "type": "string" }, "GeneralCreditStanding": { "type": "string" }, "OutstandingDebtOverview": { "type": "string" }, "NotableEvents": { "type": "string" }, "PensionAndOPEBNotes": { "type": "string" }, "KeyRevenueSources": { "type": "string" }, "EMMAReferenceURL": { "type": "string" }, "MSRBReferenceURL": { "type": "string" } } }, "NameOriginOutput": { "type": "object", "title": "NameOriginOutput", "description": "Fields appended to each record by `name-origin` (Determine Name Origin). $0.01 per record.", "properties": { "Origin": { "type": "string" } } }, "OrgStandardOutput": { "type": "object", "title": "OrgStandardOutput", "description": "Fields appended to each record by `org-standard` (Standardize Organization Name). $0.01 per record.", "properties": { "Standard": { "type": "string" } } }, "ParentCompanyOutput": { "type": "object", "title": "ParentCompanyOutput", "description": "Fields appended to each record by `parent-company` (Parent Company Info). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "CompanyURL": { "type": "string" }, "ParentCompany": { "type": "string" }, "ParentCompanyLocation": { "type": "string" }, "ParentCompanyURL": { "type": "string" }, "ParentCompanyDescription": { "type": "string" }, "ParentCompanyReferenceURL": { "type": "string" } } }, "PhoneProfileOutput": { "type": "object", "title": "PhoneProfileOutput", "description": "Fields appended to each record by `phone-profile` (Phone Number Profile). $0.25 per record.", "properties": { "Normalized": { "type": "string" }, "Country": { "type": "string" }, "Organization": { "type": "string" }, "Type": { "type": "string" }, "Carrier": { "type": "string" }, "TimeZone": { "type": "string" }, "Region": { "type": "string" }, "IsValid": { "type": "string" }, "RiskAssessment": { "type": "string" } } }, "PrivateCompanyDealIntelOutput": { "type": "object", "title": "PrivateCompanyDealIntelOutput", "description": "Fields appended to each record by `private-company-deal-intel` (Private Company Deal Intel). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "FoundedYear": { "type": "string" }, "Headquarters": { "type": "string" }, "FundingHistory": { "type": "string" }, "TotalFundingRaised": { "type": "string" }, "LatestValuation": { "type": "string" }, "KeyInvestors": { "type": "string" }, "RevenueEstimate": { "type": "string" }, "HeadcountTrend": { "type": "string" }, "ComparableCompanies": { "type": "string" }, "DataConfidence": { "type": "string" } } }, "PropertyHistoryOutput": { "type": "object", "title": "PropertyHistoryOutput", "description": "Fields appended to each record by `property-history` (Property Transaction History). $0.25 per record.", "properties": { "PropertyAddress": { "type": "string" }, "PropertyType": { "type": "string" }, "LastSaleDate": { "type": "string" }, "LastSalePrice": { "type": "string" }, "PriorTransactions": { "type": "string" }, "PricePerSqFtTrajectory": { "type": "string" }, "OwnershipChain": { "type": "string" }, "DeedTypes": { "type": "string" }, "MortgageHistory": { "type": "string" }, "CurrentOwner": { "type": "string" }, "AssessorParcelNumber": { "type": "string" }, "PropertyReferenceURL": { "type": "string" } } }, "SalesUseTaxRatesOutput": { "type": "object", "title": "SalesUseTaxRatesOutput", "description": "Fields appended to each record by `sales-use-tax-rates` (US Sales & Use Tax Rates). $0.25 per record.", "properties": { "Jurisdiction": { "type": "string" }, "JurisdictionLevel": { "type": "string" }, "LookupType": { "type": "string" }, "State": { "type": "string" }, "County": { "type": "string" }, "City": { "type": "string" }, "StateRate": { "type": "string" }, "CountyRate": { "type": "string" }, "CityRate": { "type": "string" }, "DistrictSpecialRate": { "type": "string" }, "CombinedRate": { "type": "string" }, "RateEffectiveDate": { "type": "string" }, "TaxAuthorityReferenceURL": { "type": "string" } } }, "SicCodesOutput": { "type": "object", "title": "SicCodesOutput", "description": "Fields appended to each record by `sic-codes` (SIC Codes). $0.25 per record.", "properties": { "CompanyName": { "type": "string" }, "PrimarySICCode": { "type": "string" }, "PrimarySICCodeTitle": { "type": "string" }, "PrimarySICBasis": { "type": "string" }, "AdditionalSICCodes": { "type": "string" }, "AdditionalSICCodeTitles": { "type": "string" }, "SICSourceType": { "type": "string" }, "SICSourceReferenceURL": { "type": "string" }, "ConfidenceScore": { "type": "string" } } }, "StateStandardOutput": { "type": "object", "title": "StateStandardOutput", "description": "Fields appended to each record by `state-standard` (Standardize State/Province). $0.01 per record.", "properties": { "State": { "type": "string" }, "Abbreviation": { "type": "string" } } }, "StockAnalysisOutput": { "type": "object", "title": "StockAnalysisOutput", "description": "Fields appended to each record by `stock-analysis` (Stock Analysis). $0.25 per record.", "properties": { "Ticker": { "type": "string" }, "Exchange": { "type": "string" }, "Company": { "type": "string" }, "Website": { "type": "string" }, "Description": { "type": "string" }, "MarketCap": { "type": "string" }, "CurrentPrice": { "type": "string" }, "AnalystAssessment": { "type": "string" }, "PERatio": { "type": "string" }, "EPS": { "type": "string" } } }, "TechStackOutput": { "type": "object", "title": "TechStackOutput", "description": "Fields appended to each record by `tech-stack` (Website Tech Stack). $0.25 per record.", "properties": { "DomainName": { "type": "string" }, "CMSPlatform": { "type": "string" }, "FrontendFrameworks": { "type": "string" }, "BackendTechnologies": { "type": "string" }, "WebServer": { "type": "string" }, "HostingProvider": { "type": "string" }, "CDNProvider": { "type": "string" }, "AnalyticsTools": { "type": "string" }, "SecurityTechnologies": { "type": "string" }, "EcommercePlatform": { "type": "string" }, "AdditionalTechnologies": { "type": "string" } } }, "TranslateOutput": { "type": "object", "title": "TranslateOutput", "description": "Fields appended to each record by `translate` (Translate to Any Language). $0.01 per record.", "properties": { "Result": { "type": "string" } } }, "UniversityInfoOutput": { "type": "object", "title": "UniversityInfoOutput", "description": "Fields appended to each record by `university-info` (University & College Lookup). $0.25 per record.", "properties": { "InstitutionName": { "type": "string" }, "Location": { "type": "string" }, "InstitutionType": { "type": "string" }, "Enrollment": { "type": "string" }, "AcceptanceRate": { "type": "string" }, "TuitionInState": { "type": "string" }, "TuitionOutOfState": { "type": "string" }, "Ranking": { "type": "string" }, "Website": { "type": "string" } } }, "XHandleOutput": { "type": "object", "title": "XHandleOutput", "description": "Fields appended to each record by `x-handle` (X Handle). $0.05 per record.", "properties": { "Handle": { "type": "string" }, "ConfidenceScore": { "type": "string" } } }, "PaymentRequiredResponse": { "type": "object", "title": "PaymentRequiredResponse", "description": "The x402 version 2 challenge body. Lists the payment options the caller may\nsatisfy in order to retry the request successfully.\n", "required": [ "x402Version", "accepts" ], "properties": { "x402Version": { "type": "integer", "description": "The x402 protocol version this server speaks.", "examples": [ 2 ] }, "resource": { "$ref": "#/components/schemas/X402Resource" }, "accepts": { "type": "array", "description": "One or more acceptable payment requirements.", "items": { "$ref": "#/components/schemas/PaymentRequirements" } }, "extensions": { "type": "object", "description": "Protocol extensions declared by this resource. The `bazaar` key carries\ndiscovery metadata that facilitator catalogs index, describing the request\nparameters and an example.\n", "additionalProperties": true }, "error": { "type": "string", "description": "Why payment is required.", "examples": [ "Payment Required" ] } } }, "X402Resource": { "type": "object", "title": "X402Resource", "description": "Identifies and describes the resource being paid for.", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "description": "Canonical URL of the resource.", "examples": [ "https://enrich-api.interzoid.com/enrich" ] }, "description": { "type": "string", "description": "Human-readable description of the job being paid for, including the function,\nthe number of records, the price per record, and the total.\n" }, "mimeType": { "type": "string", "description": "Media type of the resource returned after payment.", "examples": [ "application/json" ] } } }, "PaymentRequirements": { "type": "object", "title": "PaymentRequirements", "description": "A single acceptable way to pay for this resource.", "required": [ "scheme", "network", "amount", "payTo", "asset" ], "properties": { "scheme": { "type": "string", "description": "Payment scheme.", "examples": [ "exact" ] }, "network": { "type": "string", "description": "CAIP-2 network identifier.", "examples": [ "eip155:8453" ] }, "amount": { "type": "string", "description": "Exact amount for the records sent, in the smallest unit of the asset: the\nnumber of records times the function's price per record. USDC carries six\ndecimals, so 50000 is 0.05 USD Coin (5 records at $0.01).\n", "examples": [ "50000" ] }, "resource": { "$ref": "#/components/schemas/X402Resource" }, "description": { "type": "string", "description": "Human-readable description of the job. Duplicated from the parent object for\nv1 compatibility. Optional.\n" }, "mimeType": { "type": "string", "description": "Media type of the resource returned after payment. Duplicated from the parent\nobject for v1 compatibility. Optional.\n", "examples": [ "application/json" ] }, "payTo": { "type": "string", "description": "Address that receives the payment.", "examples": [ "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566" ] }, "maxTimeoutSeconds": { "type": "integer", "description": "How long the server will wait for settlement.", "examples": [ 60 ] }, "asset": { "type": "string", "description": "Contract address of the asset used for payment.", "examples": [ "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ] }, "extra": { "type": "object", "description": "Scheme-specific and asset-specific detail.", "additionalProperties": true } } } }, "headers": { "PAYMENT-REQUIRED": { "description": "Base64-encoded JSON payment requirements, as defined by x402 v2. Sent alongside\nthe JSON challenge body, which carries the same information. Clients sign one\nof the listed requirements and retry the request with a PAYMENT-SIGNATURE\nheader.\n", "required": false, "schema": { "type": "string" } }, "PAYMENT-RESPONSE": { "description": "Base64-encoded settlement receipt returned on a successful paid call.\n", "required": false, "schema": { "type": "string" } }, "X-Enrich-Language": { "description": "The language applied to the job: the language code sent to the function,\n`ignored` when a language was requested but the function does not take one, or\n`none` when no language was requested.\n", "required": false, "schema": { "type": "string" }, "examples": { "applied": { "summary": "German was applied", "value": "de" }, "ignored": { "summary": "The function does not take a language", "value": "ignored" } } } }, "responses": { "BadRequest": { "description": "Bad request. A parameter is missing or invalid, the JSON body is malformed, the\nrecords have mixed shapes or exceed 100, an input could not be mapped to a field,\nor the API key is invalid or lacks the credits for the whole job. The plain-text\nbody says exactly what to change.\n", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "unmappedInput": { "summary": "Objects without a field for the lookup input", "value": "records are JSON objects with fields [id, company]; say which field holds the \"lookup\" input with lookup_field= (for example lookup_field=company)" }, "customWithoutTopic": { "summary": "function=custom without a topic", "value": "'topic_value' is required when function=custom" }, "tooManyRecords": { "summary": "More than 100 records in the body", "value": "body contains 150 records, which exceeds the maximum of 100 inline records per request; use the 'connection' file parameter for larger jobs" } } } } }, "PaymentRequired": { "description": "Payment required. The request arrived without credentials, so the service\nreplied with x402 payment instructions and the exact price for the records sent.\nSign one of the listed payment requirements and repeat the same request, with the\nsame body, adding a PAYMENT-SIGNATURE header to receive the result.\n\nA payment that fails verification or settlement is also answered with 402, with a\nplain-text reason.\n", "headers": { "PAYMENT-REQUIRED": { "$ref": "#/components/headers/PAYMENT-REQUIRED" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequiredResponse" }, "example": { "x402Version": 2, "resource": { "url": "https://enrich-api.interzoid.com/enrich", "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json" }, "accepts": [ { "scheme": "exact", "network": "eip155:8453", "amount": "50000", "resource": { "url": "https://enrich-api.interzoid.com/enrich", "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json" }, "description": "Interzoid batch enrichment, function \"org-standard\": 5 records at $0.01/record = $0.05 total.", "mimeType": "application/json", "payTo": "0xdCEca23FF8A7145e1b5B35427C9886CF21A67566", "maxTimeoutSeconds": 60, "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "extra": { "name": "USD Coin", "version": "2" } } ], "extensions": { "bazaar": { "info": { "input": { "connection": "https://dl.interzoid.com/csv/companies.csv", "filetype": "csv", "function": "business-info", "lookup_column": "1" } }, "schema": { "properties": { "connection": { "description": "Optional. Public URL (http/https) of an input CSV/TSV file, or an S3 object key. Not needed for up to 100 records: omit it and POST the records as a JSON body instead (objects, values, or row arrays), and the response is JSON.", "type": "string" }, "filetype": { "description": "Optional. For a file: its format, csv or tsv. For POSTed JSON records: the output format, json (default), csv, or tsv.", "type": "string" }, "function": { "description": "Enrichment function, for example business-info, email-trust-score, industry-codes, org-standard, or custom. Each has its own inputs, output fields, and per-record price: GET /functions returns the full catalog with a ready-to-run example for each, and /llms-full.txt is the complete guide.", "enum": [ "address-parse", "building-profile", "business-info", "business-info-domain", "business-info-name", "buying-signals", "city-standard", "company-verification", "competitor-analysis", "country-standard", "custom", "customs-duty-rates", "email-domain-type", "email-trust-score", "entity-type", "esg-profile", "eu-vat-rates", "executive-profile", "facilities-profile", "gender-from-name", "gov-contracts", "industry-codes", "ip-profile", "irs-per-diem-rates", "muni-issuer-profile", "name-origin", "org-standard", "parent-company", "phone-profile", "private-company-deal-intel", "property-history", "sales-use-tax-rates", "sic-codes", "state-standard", "stock-analysis", "tech-stack", "translate", "university-info", "x-handle" ], "type": "string" }, "language": { "description": "Optional. Get enriched results in the language of your choice, applied to the whole job. Supported languages (code and English name): fr (French), de (German), it (Italian), es (Spanish), ja (Japanese), pt (Portuguese), zh (Mandarin), ar (Arabic), nl (Dutch), el (Greek), tr (Turkish), ko (Korean), sv (Swedish), vi (Vietnamese), th (Thai), id (Indonesian). Default English. Taken by the premium intelligence functions (for example business-info, parent-company, executive-profile, industry-codes, and custom); GET /functions shows supports_language for each function, and /.well-known/x402.json lists them under languageSupport. Same per-record price in every language. The language value may be a two-letter code, an English name, or the native name, and is not case-sensitive. An unsupported language, or a function that is not a premium function, returns English; it is never an error. Output column names do not change.", "type": "string" }, "lookup_column": { "description": "Optional. For a file or POSTed row arrays: 1-based column index of the value (company, email, name, etc.) the function looks up. Some functions use a different input name (for example email_column); see GET /functions. Not needed for POSTed plain values with a single-input function.", "type": "string" }, "lookup_field": { "description": "Optional. For POSTed JSON objects: the field that holds the lookup value, for example lookup_field=company. Other inputs use _field. Not needed when the objects have a single field or a field named like the input (lookup, email, org, and so on). Each object is returned with the enriched fields appended.", "type": "string" } }, "required": [ "function" ] } } }, "error": "Payment Required" } }, "text/plain": { "schema": { "type": "string" }, "example": "Payment verification failed" } } }, "ServerError": { "description": "Server error. The input file could not be retrieved, or payment verification or\nsettlement could not be completed. Try again later. The plain-text body describes\nthe problem.\n", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "fileNotFound": { "summary": "The connection URL could not be downloaded", "value": "file retrieval failed: HTTP download returned status 404 for \"https://example.com/missing.csv\"" }, "verificationError": { "summary": "The payment facilitator could not be reached", "value": "Payment verification error" } } } } } } }, "x-languages": [ { "code": "fr", "name": "French", "native": "Français" }, { "code": "de", "name": "German", "native": "Deutsch" }, { "code": "it", "name": "Italian", "native": "Italiano" }, { "code": "es", "name": "Spanish", "native": "Español" }, { "code": "ja", "name": "Japanese", "native": "日本語" }, { "code": "pt", "name": "Portuguese", "native": "Português" }, { "code": "zh", "name": "Mandarin", "native": "中文" }, { "code": "ar", "name": "Arabic", "native": "العربية" }, { "code": "nl", "name": "Dutch", "native": "Nederlands" }, { "code": "el", "name": "Greek", "native": "ελληνικά" }, { "code": "tr", "name": "Turkish", "native": "Türkçe" }, { "code": "ko", "name": "Korean", "native": "한국어" }, { "code": "sv", "name": "Swedish", "native": "Svenska" }, { "code": "vi", "name": "Vietnamese", "native": "Tiếng Việt" }, { "code": "th", "name": "Thai", "native": "ภาษาไทย" }, { "code": "id", "name": "Indonesian", "native": "Bahasa Indonesia" } ], "x-enrich-functions": [ { "name": "address-parse", "title": "Address Parse", "description": "Address Parse - parse address into component elements", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "address", "description": "Full address string to parse", "example": "922 N 5th St Suite 100A Phoenix AZ 85004" } ], "outputSchema": "#/components/schemas/AddressParseOutput", "productUrl": "https://www.interzoid.com/apis/address-parse" }, { "name": "building-profile", "title": "Building Profile", "description": "Building Profile - commercial building intelligence by address", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "address", "description": "Full U.S. property address", "example": "415 Mission St, San Francisco, CA 94105" } ], "outputSchema": "#/components/schemas/BuildingProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-building-profile" }, { "name": "business-info", "title": "Business Info", "description": "Get Business Info - comprehensive business intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name, web domain, or email address", "example": "Cisco" } ], "outputSchema": "#/components/schemas/BusinessInfoOutput", "productUrl": "https://www.interzoid.com/apis/get-business-info" }, { "name": "business-info-domain", "title": "Business Info Domain", "description": "Get Business Info Domain - company primary internet domain", "creditsPerRecord": 10, "pricePerRecordUSD": "0.10", "priceFor100RecordsUSD": "10.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name to look up", "example": "Salesforce" } ], "outputSchema": "#/components/schemas/BusinessInfoDomainOutput", "productUrl": "https://www.interzoid.com/apis/get-business-info-domain" }, { "name": "business-info-name", "title": "Business Info Name", "description": "Get Business Info Name - standard/official company name", "creditsPerRecord": 10, "pricePerRecordUSD": "0.10", "priceFor100RecordsUSD": "10.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name to standardize", "example": "IBM Corp" } ], "outputSchema": "#/components/schemas/BusinessInfoNameOutput", "productUrl": "https://www.interzoid.com/apis/get-business-info-name" }, { "name": "buying-signals", "title": "Buying Signals", "description": "Buying Signals - B2B purchase intent intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name", "example": "SpaceX" } ], "outputSchema": "#/components/schemas/BuyingSignalsOutput", "productUrl": "https://www.interzoid.com/apis/get-buying-signals" }, { "name": "city-standard", "title": "Standardize City Name", "description": "Standardize City Name - normalize inconsistent city data", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "city", "description": "City name to standardize", "example": "L.A." } ], "outputSchema": "#/components/schemas/CityStandardOutput", "productUrl": "https://www.interzoid.com/apis/standardize-city-data" }, { "name": "company-verification", "title": "Company Verification", "description": "Company Verification - legitimacy scoring 0-99", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name or domain", "example": "IBM" } ], "outputSchema": "#/components/schemas/CompanyVerificationOutput", "productUrl": "https://www.interzoid.com/apis/get-company-verification" }, { "name": "competitor-analysis", "title": "Competitor Analysis", "description": "Competitor Analysis - structured competitive intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name", "example": "Databricks" } ], "outputSchema": "#/components/schemas/CompetitorAnalysisOutput", "productUrl": "https://www.interzoid.com/apis/get-competitor-analysis" }, { "name": "country-standard", "title": "Standardize Country Name", "description": "Standardize Country Name - normalize inconsistent country data", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "country", "description": "Country name to standardize", "example": "uae" } ], "outputSchema": "#/components/schemas/CountryStandardOutput", "productUrl": "https://www.interzoid.com/apis/standardize-country-data" }, { "name": "custom", "title": "Custom Data", "description": "Define your own enrichment: describe a topic (topic_value) and list the output fields you want (output_fields_value).", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "The subject to retrieve data about.", "example": "Denver" } ], "requiredQueryParams": [ "topic_value", "output_fields_value" ], "outputSchema": "#/components/schemas/CustomOutput", "productUrl": "https://www.interzoid.com/apis/ai-custom-data" }, { "name": "customs-duty-rates", "title": "Customs Duty Rates", "description": "Customs Duty Rates - all import taxes for a trade route (origin to destination) and HS code: MFN duty, applicable preferential FTA rate, trade-remedy duties (anti-dumping, countervailing, Section 301), safeguard measures, import VAT/GST, special destination-country taxes, and de minimis thresholds", "creditsPerRecord": 35, "pricePerRecordUSD": "0.35", "priceFor100RecordsUSD": "35.00", "multilingual": true, "inputs": [ { "name": "origin", "description": "Origin (export) country name or ISO code", "example": "China" }, { "name": "lookup", "description": "Destination (import) country name or ISO code", "example": "Germany" }, { "name": "hscode", "description": "6-to-10 digit HS classification code", "example": "8471.30" } ], "outputSchema": "#/components/schemas/CustomsDutyRatesOutput", "productUrl": "https://www.interzoid.com/apis/get-customs-duty-rates" }, { "name": "email-domain-type", "title": "Email Domain Type", "description": "Get Email Domain Type - classify email domain (Disposable, Generic, Educational, Business, Government, Unknown)", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "email", "description": "Email address to classify", "example": "tomj@ibm.com" } ], "outputSchema": "#/components/schemas/EmailDomainTypeOutput", "productUrl": "https://www.interzoid.com/apis/get-email-domain-type" }, { "name": "email-trust-score", "title": "Email Trust Score", "description": "Email Trust Score - email quality scoring 0-99", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Email address", "example": "billsmith1@msn.com" } ], "outputSchema": "#/components/schemas/EmailTrustScoreOutput", "productUrl": "https://www.interzoid.com/apis/email-trust-score" }, { "name": "entity-type", "title": "Determine Entity Type", "description": "Determine Entity Type - classify as person or organization", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "text", "description": "Text data value to classify (person, organization, location, phone, email, website, number, or text)", "example": "Argentina" } ], "outputSchema": "#/components/schemas/EntityTypeOutput", "productUrl": "https://www.interzoid.com/apis/determine-entity-type" }, { "name": "esg-profile", "title": "ESG & Sustainability Profile", "description": "ESG & Sustainability Profile - risk rating, emissions, and disclosure intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name or domain", "example": "Microsoft" } ], "outputSchema": "#/components/schemas/EsgProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-esg-profile" }, { "name": "eu-vat-rates", "title": "European VAT Rates", "description": "European VAT Rates - standard, reduced, super-reduced, and zero-rated category breakdowns for any European country", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Country name, ISO-2/ISO-3 code, city, address, or region in Europe", "example": "Germany" } ], "outputSchema": "#/components/schemas/EuVatRatesOutput", "productUrl": "https://www.interzoid.com/apis/get-eu-vat-rates" }, { "name": "executive-profile", "title": "Executive Profile", "description": "Get Executive Profile - corporate leadership intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name and executive title", "example": "Amazon AWS CEO" } ], "outputSchema": "#/components/schemas/ExecutiveProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-executive-profile" }, { "name": "facilities-profile", "title": "Corporate Facilities Profile", "description": "Corporate Facilities Profile - real estate and operational footprint intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name", "example": "Amazon" } ], "outputSchema": "#/components/schemas/FacilitiesProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-facilities-profile" }, { "name": "gender-from-name", "title": "Determine Gender from Name", "description": "Determine Gender from Name - identify likely gender", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "name", "description": "First name or full name", "example": "Pierre" } ], "outputSchema": "#/components/schemas/GenderFromNameOutput", "productUrl": "https://www.interzoid.com/apis/determine-gender-from-name" }, { "name": "gov-contracts", "title": "Government Contracts", "description": "Government Contracts - U.S. federal contracting intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name", "example": "Lockheed Martin" } ], "outputSchema": "#/components/schemas/GovContractsOutput", "productUrl": "https://www.interzoid.com/apis/get-gov-contracts" }, { "name": "industry-codes", "title": "Industry Codes", "description": "Industry Codes - primary NAICS/SIC codes (numeric only) with official code titles and sector analysis", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name", "example": "Oracle" } ], "outputSchema": "#/components/schemas/IndustryCodesOutput", "productUrl": "https://www.interzoid.com/apis/get-industry-classification" }, { "name": "ip-profile", "title": "IP Address Profile", "description": "Get IP Address Profile - IP intelligence and reputation", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "IP address", "example": "8.8.8.8" } ], "outputSchema": "#/components/schemas/IpProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-ip-profile" }, { "name": "irs-per-diem-rates", "title": "IRS Per Diem Rates", "description": "IRS Per Diem Rates - high-low per diem classification and lodging/M&IE breakdown for accountable-plan employer reimbursement", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "US address, ZIP code, city, county, or state", "example": "Manhattan, NY" } ], "outputSchema": "#/components/schemas/IrsPerDiemRatesOutput", "productUrl": "https://www.interzoid.com/apis/get-irs-per-diem-rates" }, { "name": "muni-issuer-profile", "title": "Municipal Issuer Profile", "description": "Municipal Issuer Profile - US muni securities issuer research with credit standing, security types, debt overview, pension exposure, and EMMA links", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "US municipal issuer name (state, city, county, school district, authority, etc.)", "example": "State of California" } ], "outputSchema": "#/components/schemas/MuniIssuerProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-muni-issuer-profile" }, { "name": "name-origin", "title": "Determine Name Origin", "description": "Determine Name Origin - identify likely country of origin", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "name", "description": "Person name to analyze", "example": "Pierre Bonaparte" } ], "outputSchema": "#/components/schemas/NameOriginOutput", "productUrl": "https://www.interzoid.com/apis/determine-name-origin" }, { "name": "org-standard", "title": "Standardize Organization Name", "description": "Standardize Organization Name - AI-powered name normalization", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "org", "description": "Organization name to standardize", "example": "B.O.A." } ], "outputSchema": "#/components/schemas/OrgStandardOutput", "productUrl": "https://www.interzoid.com/apis/get-org-standard" }, { "name": "parent-company", "title": "Parent Company Info", "description": "Get Parent Company Info - corporate ownership intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name or domain", "example": "Informatica" } ], "outputSchema": "#/components/schemas/ParentCompanyOutput", "productUrl": "https://www.interzoid.com/apis/get-parent-company-info" }, { "name": "phone-profile", "title": "Phone Number Profile", "description": "Phone Number Profile - phone intelligence and risk assessment", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Phone number", "example": "650-253-0000" } ], "outputSchema": "#/components/schemas/PhoneProfileOutput", "productUrl": "https://www.interzoid.com/apis/get-phone-number-profile" }, { "name": "private-company-deal-intel", "title": "Private Company Deal Intel", "description": "Private Company Deal Intel - VC/PE investment intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Private company name", "example": "Anthropic" } ], "outputSchema": "#/components/schemas/PrivateCompanyDealIntelOutput", "productUrl": "https://www.interzoid.com/apis/get-private-company-deal-intel" }, { "name": "property-history", "title": "Property Transaction History", "description": "Property Transaction History - real estate transaction and ownership intelligence", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "address", "description": "Full U.S. property address", "example": "600 Montgomery St, San Francisco, CA 94111" } ], "outputSchema": "#/components/schemas/PropertyHistoryOutput", "productUrl": "https://www.interzoid.com/apis/get-property-history" }, { "name": "sales-use-tax-rates", "title": "US Sales & Use Tax Rates", "description": "US Sales & Use Tax Rates - state, county, city, and district rates by address/ZIP/city/state", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "US address, ZIP code, city, or state", "example": "Beverly Hills, CA 90210" } ], "outputSchema": "#/components/schemas/SalesUseTaxRatesOutput", "productUrl": "https://www.interzoid.com/apis/get-sales-use-tax-rates" }, { "name": "sic-codes", "title": "SIC Codes", "description": "SIC Codes - primary SIC code (numeric only) with official title and assignment basis, additional SIC codes for secondary lines of business, and primary code source provenance", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Company name", "example": "Oracle" } ], "outputSchema": "#/components/schemas/SicCodesOutput", "productUrl": "https://www.interzoid.com/apis/get-sic-codes" }, { "name": "state-standard", "title": "Standardize State/Province", "description": "Standardize State/Province - abbreviation and standard name", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "state", "description": "State or province name to standardize", "example": "calif." } ], "outputSchema": "#/components/schemas/StateStandardOutput", "productUrl": "https://www.interzoid.com/apis/standardize-state-province-data" }, { "name": "stock-analysis", "title": "Stock Analysis", "description": "Stock Analysis - comprehensive stock data and analysis", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Stock ticker symbol", "example": "NVDA" } ], "outputSchema": "#/components/schemas/StockAnalysisOutput", "productUrl": "https://www.interzoid.com/apis/get-stock-analysis" }, { "name": "tech-stack", "title": "Website Tech Stack", "description": "Website Tech Stack - comprehensive technology stack detection", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Website domain name", "example": "shopify.com" } ], "outputSchema": "#/components/schemas/TechStackOutput", "productUrl": "https://www.interzoid.com/apis/get-tech-stack" }, { "name": "translate", "title": "Translate to Any Language", "description": "Translate to Any Language - text translation", "creditsPerRecord": 1, "pricePerRecordUSD": "0.01", "priceFor100RecordsUSD": "1.00", "multilingual": false, "inputs": [ { "name": "text", "description": "Text string to translate", "example": "Everybody Everywhere" }, { "name": "to", "description": "Target language for translation", "example": "Portuguese" } ], "outputSchema": "#/components/schemas/TranslateOutput", "productUrl": "https://www.interzoid.com/apis/translate-to-any" }, { "name": "university-info", "title": "University & College Lookup", "description": "University & College Lookup - higher education data", "creditsPerRecord": 25, "pricePerRecordUSD": "0.25", "priceFor100RecordsUSD": "25.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "University or college name", "example": "Ohio State" } ], "outputSchema": "#/components/schemas/UniversityInfoOutput", "productUrl": "https://www.interzoid.com/apis/get-university-info" }, { "name": "x-handle", "title": "X Handle", "description": "Get X Handle - AI-powered X/Twitter handle lookup", "creditsPerRecord": 5, "pricePerRecordUSD": "0.05", "priceFor100RecordsUSD": "5.00", "multilingual": true, "inputs": [ { "name": "lookup", "description": "Person, organization, team, or entity", "example": "Amazon CEO" } ], "outputSchema": "#/components/schemas/XHandleOutput", "productUrl": "https://www.interzoid.com/apis/get-x-handle" } ] }