{ "openapi": "3.0.1", "info": { "title": "ZIP Code Lookup", "description": "Look up ZIP and postal codes in bulk across selected countries, or find postal codes from a city and state or province. Get structured country, place, region, and coordinate data without a source API key.", "version": "0.0", "x-build-id": "mJGw2UzK8sA6w838r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~zip-code-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-zip-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/maximedupre~zip-code-lookup/runs": { "post": { "operationId": "runs-sync-maximedupre-zip-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/maximedupre~zip-code-lookup/run-sync": { "post": { "operationId": "run-sync-maximedupre-zip-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": [ "target", "countryCodes" ], "properties": { "target": { "title": "Target", "enum": [ "postalCodeLookup", "cityStateLookup" ], "type": "string", "description": "Choose the lookup type for this run.", "default": "postalCodeLookup" }, "postalCodes": { "title": "Postal or ZIP values", "minItems": 1, "type": "array", "description": "Enter one or more postal or ZIP values. Each item can be an exact value or a numeric range such as `00501-00503`; leading zeros stay in place.", "items": { "type": "string", "pattern": "^\\S(?:.*\\S)?$" } }, "maxPlacesPerCode": { "title": "Max places per postal code", "minimum": 1, "type": "integer", "description": "Optionally stop each postal code after this many place records. Leave it empty to return all available results until the source is exhausted." }, "city": { "title": "City", "pattern": "^\\S(?:.*\\S)?$", "type": "string", "description": "Enter the city for the reverse lookup." }, "region": { "title": "State or province", "pattern": "^\\S(?:.*\\S)?$", "type": "string", "description": "Enter the state or province for the reverse lookup." }, "countryCodes": { "title": "Country codes", "minItems": 1, "type": "array", "description": "Enter one or more ISO 3166-1 alpha-2 country codes, such as `US` or `CA`. The same lookup values are checked for each code.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" } }, "detailLevel": { "title": "Result detail", "enum": [ "postalCode", "place", "full" ], "type": "string", "description": "Choose how much detail each result keeps. Postal code only keeps the code and country. Postal code and place also keeps the place and region. The full choice also keeps available latitude/longitude data.", "default": "full" }, "notFoundPolicy": { "title": "Unmatched values", "enum": [ "omit", "keep" ], "type": "string", "description": "Choose whether a value with no match is left out or kept as a record with no result data.", "default": "omit" }, "sortBy": { "title": "Sort results by", "enum": [ "postalCode", "place", "region", "latitude", "longitude" ], "type": "string", "description": "Choose the field used to order returned records after the lookups finish.", "default": "postalCode" } } }, "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 } } }, "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 } } } } } } } } } }