{ "openapi": "3.0.1", "info": { "title": "TX Business Entities - Franchise Taxpayers & SOS Status", "description": "Texas business-entity register (public open data, 3.45M active franchise-tax taxpayers): SOS file number, charter date, registration status and right-to-transact flag, organizational type, registered address, county and franchise-tax responsibility date - filter by name, id, county, type or date.", "version": "0.0", "x-build-id": "rfmfjX5ds01hPIGTT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~tx-business-entities/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-tx-business-entities", "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/j0401~tx-business-entities/runs": { "post": { "operationId": "runs-sync-j0401-tx-business-entities", "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/j0401~tx-business-entities/run-sync": { "post": { "operationId": "run-sync-j0401-tx-business-entities", "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", "properties": { "mode": { "title": "Mode", "enum": [ "search", "profile", "aggregate" ], "type": "string", "description": "search = entities matching your filters (default). profile = one entity by taxpayerId or sosFileNumber. aggregate = one count row per group (see groupBy).", "default": "search" }, "name": { "title": "Entity name", "type": "string", "description": "Entity name substring, e.g. 'BALLET', 'CONTRACTING'. Case-insensitive. Blank = any.", "default": "" }, "taxpayerId": { "title": "Taxpayer number", "type": "string", "description": "Exact 11-digit Comptroller taxpayer number, e.g. '32107752175'. The register's own entity id.", "default": "" }, "sosFileNumber": { "title": "SOS file number", "type": "string", "description": "Exact Secretary of State file number, e.g. '0806763317'. The number on the SOS formation document.", "default": "" }, "county": { "title": "County", "type": "string", "description": "Texas county by name, e.g. 'Harris', 'Travis'. Exact name or an unambiguous prefix; an ambiguous prefix reports the candidates. Blank = any.", "default": "" }, "countyCode": { "title": "County code", "type": "string", "description": "Numeric Comptroller county code (the 254 Texas counties numbered alphabetically; 101 = Harris, 57 = Dallas, 227 = Travis, 220 = Tarrant, 15 = Bexar). '0' = county not reported (385,296 rows). Blank = any.", "default": "" }, "orgType": { "title": "Organizational type", "enum": [ "", "CL", "CT", "CI", "CN", "CF", "PL", "PF", "AR", "CM", "CP", "AP", "PB", "AF", "TR", "CU", "PI", "PV", "TF", "PW", "AB", "AC", "CW", "CX", "HF", "PZ", "SF", "ST", "TH", "TI" ], "type": "string", "description": "Exact organizational-type code. CL (limited liability company) ~2.25M, CT ~332k, CI ~245k, CN ~205k, CF ~182k, PL (limited partnership) ~119k. Blank = any.", "default": "" }, "sosStatus": { "title": "SOS status", "enum": [ "", "A", "R", "F", "Y", "C", "W", "V", "X", "T", "E", "D", "M", "B" ], "type": "string", "description": "Exact single-letter Secretary-of-State status code. A ~2.80M, R ~345k, F ~58k. Blank = any (240,573 rows have no SOS status at all).", "default": "" }, "rightToTransact": { "title": "Right to transact business", "enum": [ "", "A", "N", "U", "D" ], "type": "string", "description": "Exact right-to-transact-business code. A ~3.26M, N ~130k, U ~45k, D ~20k. Blank = any.", "default": "" }, "city": { "title": "City", "type": "string", "description": "Registered-address city substring, e.g. 'HOUSTON', 'DALLAS'. Blank = any.", "default": "" }, "zip": { "title": "ZIP", "type": "string", "description": "Registered-address ZIP, e.g. '78701'. Matched on the 5-digit prefix. Blank = any.", "default": "" }, "charterFrom": { "title": "Chartered on or after", "type": "string", "description": "SOS charter date on or after this date (YYYY-MM-DD). This is the registration-date stream - use it to pull entities chartered in a window. Blank = any.", "default": "" }, "charterTo": { "title": "Chartered on or before", "type": "string", "description": "SOS charter date on or before this date (YYYY-MM-DD). Blank = any.", "default": "" }, "recentDays": { "title": "Chartered in the last N days", "minimum": 0, "type": "integer", "description": "Shortcut for recently registered entities, e.g. 30 returns entities chartered in the last 30 days. Cannot be combined with charterFrom / charterTo. 0 = off.", "default": 0 }, "groupBy": { "title": "Aggregate by", "enum": [ "", "countyCode", "orgType", "sosStatus", "rightToTransact", "exemptReason", "charterYear" ], "type": "string", "description": "Which dimension to aggregate over (mode=aggregate). Blank = countyCode. Every group is returned - aggregate mode is not cut off by maxResults.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed in search / profile mode (0 = default 50; up to 10,000 per run). Each record is metered individually, so there is no per-run charge cap. Aggregate mode returns every group.", "default": 50 } } }, "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 } } } } } } } } } }