{ "openapi": "3.0.1", "info": { "title": "Brazil Tax Code Lookup: NCM, CEST, CFOP, NBS, CNAE, IBGE", "description": "Look up and cross-reference official Brazilian tax tables in one call: NCM (with hierarchy and linked CEST), CEST, CFOP, NBS, LC 116, CNAE 2.3, IBGE municipalities and IBS/CBS reform codes (CST, cClassTrib). Exact, prefix or accent-insensitive search. For AI agents, ERPs and developers.", "version": "0.1", "x-build-id": "1vYAHDq5wVrBIDVaY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brasil-data~brazil-tax-code-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brasil-data-brazil-tax-code-lookup", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/brasil-data~brazil-tax-code-lookup/runs": { "post": { "operationId": "runs-sync-brasil-data-brazil-tax-code-lookup", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/brasil-data~brazil-tax-code-lookup/run-sync": { "post": { "operationId": "run-sync-brasil-data-brazil-tax-code-lookup", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "queries" ], "properties": { "queries": { "title": "Queries (codes or texts)", "type": "array", "description": "Codes or free texts to look up, one per line. Codes may be typed with or without punctuation (8471.30.12 or 84713012, 5.102 or 5102, 6201-5/01, 3550308). Texts are matched without accents (e.g. 'parafuso', 'sao paulo', 'suporte informatica'). Maximum 1000 per run.", "items": { "type": "string" } }, "table": { "title": "Table", "enum": [ "auto", "ncm", "cest", "cfop", "nbs", "lc116", "cnae", "municipality", "reform_class" ], "type": "string", "description": "Which table to search. 'auto' searches all tables and may return the same code from several tables (e.g. 5102 is CFOP 5.102 and NCM heading 51.02); pick a table to restrict.", "default": "auto" }, "search_mode": { "title": "Search mode", "enum": [ "auto", "exact", "prefix", "text" ], "type": "string", "description": "'auto' = exact code match for code-like queries and text search otherwise. 'exact' = exact code. 'prefix' = every code starting with the query (e.g. 8471 -> all NCM under heading 84.71). 'text' = accent-insensitive word search in official descriptions.", "default": "auto" }, "include_related": { "title": "Include cross-references", "type": "boolean", "description": "Add related records: NCM -> linked CEST codes, CEST -> listed NCM codes, CST -> cClassTrib codes, LC 116 item -> subitems, CNAE -> child levels (and NBS <-> LC 116 / cClassTrib when the optional NFS-e correlation is bundled). Hierarchy (e.g. NCM section/chapter/heading, municipality -> state) is always returned.", "default": true }, "language": { "title": "Message language", "enum": [ "en", "pt" ], "type": "string", "description": "Language of status messages. Official descriptions are always returned in Portuguese (pt-BR) exactly as published; no machine translation is applied.", "default": "en" }, "max_results_per_query": { "title": "Max results per query", "minimum": 1, "maximum": 200, "type": "integer", "description": "Upper limit of records returned for each query (relevant for prefix and text search). Each returned record is one billable result.", "default": 10 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }