{ "openapi": "3.0.1", "info": { "title": "US Address Geocoder & FEMA Flood Zone Risk API", "description": "US address geocoder with Census Bureau lat/lon, tract and block FIPS, plus FEMA flood zone and National Risk Index scores. Batch enrich from keyless official data. $3 per 1,000 addresses.", "version": "0.1", "x-build-id": "DiIZir3pWeQPcGeCX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/infocomp~us-address-risk-enricher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-infocomp-us-address-risk-enricher", "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/infocomp~us-address-risk-enricher/runs": { "post": { "operationId": "runs-sync-infocomp-us-address-risk-enricher", "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/infocomp~us-address-risk-enricher/run-sync": { "post": { "operationId": "run-sync-infocomp-us-address-risk-enricher", "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": { "addresses": { "title": "US addresses (one per line)", "type": "array", "description": "Single-line U.S. addresses, e.g. 1600 Pennsylvania Ave NW, Washington, DC 20500. Include the ZIP code (or city and state) for the best match rate. Up to 50,000 per run.", "default": [ "1600 Pennsylvania Ave NW, Washington, DC 20500", "800 Decatur St, New Orleans, LA 70116", "400 Broad St, Seattle, WA 98109", "3251 South Miami Avenue, Miami, FL 33129", "2313 Red River Street, Austin, TX 78705" ], "items": { "type": "string" } }, "structuredAddresses": { "title": "Structured addresses (optional)", "type": "array", "description": "Addresses split into fields: [{\"id\": \"your-ref-1\", \"street\": \"233 S Wacker Dr\", \"city\": \"Chicago\", \"state\": \"IL\", \"zip\": \"60606\"}]. \"id\" is optional and is echoed back as inputId. Street plus ZIP, or street plus city and state, is required." }, "mode": { "title": "Mode", "enum": [ "full", "geocode_only" ], "type": "string", "description": "Full adds the FEMA NFHL flood zone at the point and FEMA National Risk Index scores for the census tract and county. Geocode only returns lat/lon and state/county/tract/block FIPS.", "default": "full" }, "includeCountyRisk": { "title": "Include county National Risk Index", "type": "boolean", "description": "Full mode: also add the county-level National Risk Index score and rating (area score, not property-level). No extra charge.", "default": true }, "skipDuplicates": { "title": "Skip duplicate addresses", "type": "boolean", "description": "Process each distinct address once (case and punctuation ignored), so you are not charged twice for the same address.", "default": true }, "maxAddresses": { "title": "Max addresses", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many addresses (your max cost per run also applies).", "default": 50000 }, "maxConcurrency": { "title": "Max parallel FEMA requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "FEMA does not publish rate limits, so the Actor stays conservative (requests are also spaced at least 0.15 s apart and retried with exponential backoff).", "default": 4 }, "femaTimeoutSecs": { "title": "FEMA request timeout (seconds)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Each FEMA flood-map and National Risk Index request is given this long, then retried exactly once. If it still fails, the flood zone is marked \"unavailable\" and the address is billed at the $0.001 geocode-only rate.", "default": 4 } } }, "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 } } } } } } } } } }