{ "openapi": "3.0.1", "info": { "title": "East Baton Rouge Contracts - Vendor Diversity & Line Items", "description": "East Baton Rouge Parish purchase orders and contracts (~92,200 documents, $3.4bn): who won what, from which department, for how much, plus each vendor's diversity classification and the line items behind any document.", "version": "0.0", "x-build-id": "wdWAJucWEbgtrDXld" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~ebr-contracts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-ebr-contracts", "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~ebr-contracts/runs": { "post": { "operationId": "runs-sync-j0401-ebr-contracts", "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~ebr-contracts/run-sync": { "post": { "operationId": "run-sync-j0401-ebr-contracts", "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": [ "documents", "lines", "aggregate" ], "type": "string", "description": "documents = one row per purchase order or contract (default). lines = one row per line item. aggregate = one count row per group (see groupBy).", "default": "documents" }, "documentNumber": { "title": "Document number", "type": "string", "description": "Exact document number, e.g. '800007099'. Blank = any.", "default": "" }, "requisitionNumber": { "title": "Requisition number", "type": "string", "description": "Exact requisition number. One requisition is usually released as several documents. Blank = any.", "default": "" }, "vendorName": { "title": "Vendor name", "type": "string", "description": "Vendor name substring, e.g. 'DELL' or 'GRAINGER'. Blank = any.", "default": "" }, "department": { "title": "Department", "type": "string", "description": "Buying department substring, e.g. 'POLICE', 'FLEET', 'TRAN'. Blank = any.", "default": "" }, "costCenterName": { "title": "Cost center", "type": "string", "description": "Cost centre name substring. Blank = any.", "default": "" }, "documentType": { "title": "Document type", "type": "string", "description": "Substring, e.g. 'Public Works', 'Professional Serv', 'Blanket', 'Normal'.", "default": "" }, "status": { "title": "Document status", "type": "string", "description": "Substring, e.g. 'Closed' (the common case), 'Posted', 'Printed', 'Approved'. Blank = any.", "default": "" }, "vendorClass": { "title": "Vendor class", "type": "string", "description": "Exact vendor class code, e.g. 'CORP', 'LLC', 'PSHP'. Populated on about half the documents. Blank = any.", "default": "" }, "vendorState": { "title": "Vendor state", "type": "string", "description": "Two-letter vendor state, e.g. 'LA'. About 70% of documents go to an in-state vendor. Blank = any.", "default": "" }, "vendorCity": { "title": "Vendor city", "type": "string", "description": "Vendor city substring. Blank = any.", "default": "" }, "commodityCode": { "title": "Commodity code", "type": "string", "description": "Commodity code prefix, matched against line items. Blank = any.", "default": "" }, "itemDescription": { "title": "Item description", "type": "string", "description": "Line-item description substring, matched against line items. Blank = any.", "default": "" }, "minAmount": { "title": "Minimum amount", "type": "number", "description": "Lowest document total, inclusive. Leave blank for any." }, "maxAmount": { "title": "Maximum amount", "type": "number", "description": "Highest document total, inclusive. Leave blank for any." }, "inputFrom": { "title": "Entered on or after", "type": "string", "description": "Earliest document input date (YYYY-MM-DD). Blank = any.", "default": "" }, "inputTo": { "title": "Entered on or before", "type": "string", "description": "Latest document input date (YYYY-MM-DD), inclusive. Blank = any.", "default": "" }, "minorityOwned": { "title": "Minority-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (2,557 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "disadvantagedOwned": { "title": "Disadvantaged-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (1,009 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "disabledVeteranOwned": { "title": "Disabled-veteran-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (24 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallDisabledVeteran": { "title": "Small disabled-veteran", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (102 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallMinorityOwned": { "title": "Small minority-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (1,060 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallMinorityWomanOwned": { "title": "Small minority-woman-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (1,674 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallDisadvantagedOwned": { "title": "Small disadvantaged-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (440 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallVeteranOwned": { "title": "Small veteran-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (574 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallWomanOwned": { "title": "Small woman-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (2,405 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "smallNonMinorityOwned": { "title": "Small non-minority-owned", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (82 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "independentContractor": { "title": "Independent contractor", "enum": [ "", "Y", "N" ], "type": "string", "description": "Supplier diversity flag (3,247 documents marked Y). Y = only those flagged, N = only those not flagged. Blank = any.", "default": "" }, "maxResults": { "title": "Max results", "type": "integer", "description": "Maximum records to return in documents/lines mode (1-10000). Default 50.", "default": 50 }, "groupBy": { "title": "Group by", "enum": [ "department", "documentType", "documentStatus", "vendorState", "vendorClass" ], "type": "string", "description": "aggregate mode only: the dimension to count by.", "default": "department" } } }, "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 } } } } } } } } } }