{ "item": [ { "id": "1c89041f-7c36-4fc3-865d-462b08339568", "name": "Health", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "97f043d6-9334-428f-8bd0-b0a55813ed98", "name": "Health Check", "request": { "name": "Health Check", "description": { "content": "Health check endpoint for load balancers and monitoring.", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "58f97f7d-6857-4310-9724-f6f1a4f6e712", "name": "Successful Response", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa4eb852-6262-46f5-9aef-873016b02750", "name": "Ready Check", "request": { "name": "Ready Check", "description": { "content": "Readiness check - verifies all dependencies are available.", "type": "text/plain" }, "url": { "path": [ "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "20c4739f-9234-4767-b7c4-ce4f3e0764b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d27805f8-60af-4973-82dc-435110cc9993", "name": "Storm Surge", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0aa1f705-f687-46f5-bff3-9780ecf0ab63", "name": "Get storm surge risk by address or coordinates", "request": { "name": "Get storm surge risk by address or coordinates", "description": { "content": "Get storm surge risk assessment for a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Returns storm surge zones for hurricane categories 1-5 where data exists.\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "80cad5a3-2a53-445d-b58c-5e0f11ad5a2a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"storm_surge\": {\n \"in_surge_zone\": false,\n \"zones\": [\n {\n \"category\": 2,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 1,\n \"depth_ft\": 9334\n },\n {\n \"category\": 1,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 0,\n \"depth_ft\": 700\n }\n ],\n \"highest_risk_level\": 1,\n \"highest_risk_category\": \"string\",\n \"max_surge_depth_ft\": 6782\n },\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 2682.3131741053485,\n \"longitude\": 4044.8507774382915,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94afe31f-251a-45e0-9a20-7c6e62aa2faa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d1cf5e-9afa-44c6-9ff7-fe6532d41b98", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d13d1ff-e8bc-4a6b-9b8e-dab14b731894", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6b9428c-3801-4faa-b179-b16e65b1edf4", "name": "Get storm surge risk (POST)", "request": { "name": "Get storm surge risk (POST)", "description": { "content": "Get storm surge risk assessment for a location via POST request.\n \n Accepts JSON body with:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n - `maps_api_response`: Pre-fetched Google Maps geocoding response\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": 70.87769880831596,\n \"longitude\": -7.024779129922223,\n \"maps_api_response\": {\n \"key_0\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d4e78a20-0c16-4bfa-9327-7b74c3476f0b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": 70.87769880831596,\n \"longitude\": -7.024779129922223,\n \"maps_api_response\": {\n \"key_0\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"storm_surge\": {\n \"in_surge_zone\": true,\n \"zones\": [\n {\n \"category\": 4,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 2,\n \"depth_ft\": 8021\n },\n {\n \"category\": 2,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 0,\n \"depth_ft\": 8264\n }\n ],\n \"highest_risk_level\": 0,\n \"highest_risk_category\": \"string\",\n \"max_surge_depth_ft\": 265\n },\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 7308.107761781506,\n \"longitude\": 2717.6271242393323,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b9645c7-e420-4c5c-91d1-4da5cafd2370", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": 70.87769880831596,\n \"longitude\": -7.024779129922223,\n \"maps_api_response\": {\n \"key_0\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76b1f290-7a66-4175-bf14-9125d5694ff8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": 70.87769880831596,\n \"longitude\": -7.024779129922223,\n \"maps_api_response\": {\n \"key_0\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9e1199c-51a6-45bd-bb8a-63f2adeb3df2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "storm-surge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": 70.87769880831596,\n \"longitude\": -7.024779129922223,\n \"maps_api_response\": {\n \"key_0\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c2522045-66f6-44b3-98fa-22aa82439fcb", "name": "Flood Zone", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "312f2f1e-8e5b-491b-9d66-2065e70359da", "name": "Get FEMA flood zone by address or coordinates", "request": { "name": "Get FEMA flood zone by address or coordinates", "description": { "content": "Get FEMA flood zone assessment for a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Returns flood zone classification, risk level, and SFHA status.\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a5365b35-61ea-4ff9-bcc0-3eaa483262af", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"1234 Bayshore Dr, Miami Beach, FL 33139\",\n \"latitude\": 25.7617,\n \"longitude\": -80.1918\n },\n \"fema_flood_zone\": {\n \"fld_zone\": \"AE\",\n \"sfha\": true,\n \"sfha_tf\": \"T\",\n \"static_bfe\": 8,\n \"user_label\": \"High Risk\",\n \"annual_risk\": \"1 %\",\n \"version_id\": \"12086C0306L\",\n \"study_typ\": \"FE\",\n \"v_datum\": \"NAVD88\",\n \"len_unit\": \"Feet\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e58f08d-17fe-4085-9080-8fddd2f8b2a7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "886a4c51-9df2-4a57-8e06-b30051e8ef6a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a24e62-e826-4ae5-a8d8-38f24c3a86bd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Ocean Drive, Miami Beach, FL 33139" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fa1a6e4-52c3-4b77-bf14-4fbcb07716a8", "name": "Get FEMA flood zone (POST)", "request": { "name": "Get FEMA flood zone (POST)", "description": { "content": "Get FEMA flood zone assessment for a location via POST request.\n \n Accepts JSON body with:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n - `maps_api_response`: Pre-fetched Google Maps geocoding response\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": -31.122863648521147,\n \"longitude\": -162.540467845305,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30284ae6-2e97-4c76-8d26-b42dae5476a4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": -31.122863648521147,\n \"longitude\": -162.540467845305,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"1234 Bayshore Dr, Miami Beach, FL 33139\",\n \"latitude\": 25.7617,\n \"longitude\": -80.1918\n },\n \"fema_flood_zone\": {\n \"fld_zone\": \"AE\",\n \"sfha\": true,\n \"sfha_tf\": \"T\",\n \"static_bfe\": 8,\n \"user_label\": \"High Risk\",\n \"annual_risk\": \"1 %\",\n \"version_id\": \"12086C0306L\",\n \"study_typ\": \"FE\",\n \"v_datum\": \"NAVD88\",\n \"len_unit\": \"Feet\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8632eb6d-44bc-4411-97cf-f7d7f8b6d165", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": -31.122863648521147,\n \"longitude\": -162.540467845305,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b93ad1-7812-4aa0-8ac6-6008a106f5e9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": -31.122863648521147,\n \"longitude\": -162.540467845305,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd718319-95ec-46a6-bf0e-08c0b20fd25f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "flood-zone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Ocean Drive, Miami Beach, FL 33139\",\n \"latitude\": -31.122863648521147,\n \"longitude\": -162.540467845305,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b94a8b3f-0f15-498a-9d91-f1756249e6bd", "name": "Census Data", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2578511e-7355-4cbb-acf3-0503d1bb5d11", "name": "Get census data by address or coordinates", "request": { "name": "Get census data by address or coordinates", "description": { "content": "Get ACS (American Community Survey) census data for a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Optional parameters:\n - `years`: List of years (2019-2023, default: [2023])\n - `geographies`: List of geography levels (default: [\"block_group\"])\n - `census_keys`: Specific census variable keys to retrieve\n\n**API Credits:** 1 credit per census key requested (e.g., 3 keys = 3 credits).", "type": "text/plain" }, "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" }, { "disabled": false, "key": "years", "value": "2023", "description": "Years of data to retrieve (2019-2023)" }, { "disabled": false, "key": "geographies", "value": "block_group", "description": "Geography levels to retrieve" }, { "disabled": false, "key": "census_keys", "value": "string", "description": "Specific census variable keys" }, { "disabled": false, "key": "census_keys", "value": "string", "description": "Specific census variable keys" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "aa5b39ef-0a47-437a-80fd-ed3b7a77d4a8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "years", "value": "2023" }, { "key": "geographies", "value": "block_group" }, { "key": "census_keys", "value": "string" }, { "key": "census_keys", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 3889.005056690722,\n \"longitude\": 2589.8812026925343,\n \"geohash8\": \"string\"\n },\n \"census_geoids\": {\n \"state_fips\": \"string\",\n \"county_fips\": \"string\",\n \"cousub_fips\": \"string\",\n \"tract_fips\": \"string\",\n \"block_fips\": \"string\",\n \"geoid\": \"string\"\n },\n \"acs_data\": [\n {\n \"year\": 3744,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 7998.583118082954,\n \"base_variable\": \"string\"\n }\n }\n },\n {\n \"year\": 1283,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 6434.189668657941,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 4609.05284372372,\n \"base_variable\": \"string\"\n }\n }\n }\n ],\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e3d368-91e3-4a9d-801f-0fbce59b8912", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "years", "value": "2023" }, { "key": "geographies", "value": "block_group" }, { "key": "census_keys", "value": "string" }, { "key": "census_keys", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8bafed6-93f7-4702-b0fc-0001d9a064bd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "years", "value": "2023" }, { "key": "geographies", "value": "block_group" }, { "key": "census_keys", "value": "string" }, { "key": "census_keys", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02855cbb-d79d-44c4-af09-535e987a7239", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "years", "value": "2023" }, { "key": "geographies", "value": "block_group" }, { "key": "census_keys", "value": "string" }, { "key": "census_keys", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4e1c466-efd1-45a0-ae75-bd5f50f4220b", "name": "Get census data (POST)", "request": { "name": "Get census data (POST)", "description": { "content": "Get ACS census data for a location via POST request.\n \n Accepts JSON body with:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n - `maps_api_response`: Pre-fetched Google Maps geocoding response\n - `years`: List of years (default: [2023])\n - `geographies`: List of geography levels (default: [\"block_group\"])\n - `census_keys`: Specific census variable keys\n\n**API Credits:** 1 credit per census key requested (e.g., 3 keys = 3 credits).", "type": "text/plain" }, "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"years\": [\n 2023\n ],\n \"geographies\": [\n \"block_group\",\n \"tract\"\n ],\n \"census_keys\": [\n \"B01003_001E\",\n \"B19013_001E\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "60c52745-e7c8-41cb-a8c1-86992fa0701e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main Street, Tampa, FL 33602\",\n \"latitude\": 86.04103752888281,\n \"longitude\": 164.14405419555146,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 4639.628788907371\n },\n \"years\": [\n 2023\n ],\n \"geographies\": [\n \"tract\",\n \"block_group\"\n ],\n \"census_keys\": [\n \"B01002_001E\",\n \"B01003_001E\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 6567.9501269907205,\n \"longitude\": 8960.573383086283,\n \"geohash8\": \"string\"\n },\n \"census_geoids\": {\n \"state_fips\": \"string\",\n \"county_fips\": \"string\",\n \"cousub_fips\": \"string\",\n \"tract_fips\": \"string\",\n \"block_fips\": \"string\",\n \"geoid\": \"string\"\n },\n \"acs_data\": [\n {\n \"year\": 8578,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 8390.529741287752,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 717.8614477753187,\n \"base_variable\": \"string\"\n }\n }\n },\n {\n \"year\": 6876,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 1341.4165094649034,\n \"base_variable\": \"string\"\n }\n }\n }\n ],\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d194890e-fc9a-4cbf-8812-9b979af9bcc1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main Street, Tampa, FL 33602\",\n \"latitude\": 86.04103752888281,\n \"longitude\": 164.14405419555146,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 4639.628788907371\n },\n \"years\": [\n 2023\n ],\n \"geographies\": [\n \"tract\",\n \"block_group\"\n ],\n \"census_keys\": [\n \"B01002_001E\",\n \"B01003_001E\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5014099-7959-4548-be7f-a23e4c2828cd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main Street, Tampa, FL 33602\",\n \"latitude\": 86.04103752888281,\n \"longitude\": 164.14405419555146,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 4639.628788907371\n },\n \"years\": [\n 2023\n ],\n \"geographies\": [\n \"tract\",\n \"block_group\"\n ],\n \"census_keys\": [\n \"B01002_001E\",\n \"B01003_001E\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40773ef6-0a81-47fe-84b4-83cbaacebcbf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main Street, Tampa, FL 33602\",\n \"latitude\": 86.04103752888281,\n \"longitude\": 164.14405419555146,\n \"maps_api_response\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 4639.628788907371\n },\n \"years\": [\n 2023\n ],\n \"geographies\": [\n \"tract\",\n \"block_group\"\n ],\n \"census_keys\": [\n \"B01002_001E\",\n \"B01003_001E\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab300ceb-34f7-4403-8642-f3028e570d07", "name": "Get census data by GEOID", "request": { "name": "Get census data by GEOID", "description": { "content": "Get ACS census data directly by Census GEOID.\n \n This endpoint bypasses geocoding and block lookup for cases\n where the GEOID is already known.\n\n**API Credits:** 1 credit per census key requested.", "type": "text/plain" }, "url": { "path": [ "v1", "census-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"geoid\": \"string\",\n \"geography\": \"cousub\",\n \"years\": [\n 2023\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e876e6f9-9b47-446d-a881-d56c661919a7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "census-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"geoid\": \"string\",\n \"geography\": \"tract\",\n \"years\": [\n 2023\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 6567.9501269907205,\n \"longitude\": 8960.573383086283,\n \"geohash8\": \"string\"\n },\n \"census_geoids\": {\n \"state_fips\": \"string\",\n \"county_fips\": \"string\",\n \"cousub_fips\": \"string\",\n \"tract_fips\": \"string\",\n \"block_fips\": \"string\",\n \"geoid\": \"string\"\n },\n \"acs_data\": [\n {\n \"year\": 8578,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 8390.529741287752,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 717.8614477753187,\n \"base_variable\": \"string\"\n }\n }\n },\n {\n \"year\": 6876,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 1341.4165094649034,\n \"base_variable\": \"string\"\n }\n }\n }\n ],\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ae5854-fa0d-49c5-b8eb-d2aeed60433d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "census-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"geoid\": \"string\",\n \"geography\": \"tract\",\n \"years\": [\n 2023\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6223898a-7036-47b7-b2d0-b1b98a180369", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "census-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"geoid\": \"string\",\n \"geography\": \"tract\",\n \"years\": [\n 2023\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72680ece-85b9-43bc-9e51-01155f61b9fd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "census-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"geoid\": \"string\",\n \"geography\": \"tract\",\n \"years\": [\n 2023\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ef2c884e-60a9-4891-8b55-05e2a22f89b5", "name": "Crime Data", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a42c4d5a-92bc-4fd5-b7be-e78c95d0f185", "name": "Get crime data by address or coordinates", "request": { "name": "Get crime data by address or coordinates", "description": { "content": "Get crime incident data within a radius from a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Optional filters:\n - `radius_mi`: Search radius in miles (default: 1.0, max: 6.0)\n - `start_date` / `end_date`: Date range filter (YYYY-MM-DD)\n - `offense_categories`: Filter by crime categories\n - `sort_by`: Sort order (recency or distance)\n\n**API Credits:** 10 credits base. When incidents are returned via include_crime_details, add 1 credit per 5 incidents (rounded up). Example: 50 incidents = 10 + 10 = 20 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" }, { "disabled": false, "key": "radius_mi", "value": "1", "description": "Search radius in miles" }, { "disabled": false, "key": "start_date", "value": "string", "description": "Start date (YYYY-MM-DD)" }, { "disabled": false, "key": "end_date", "value": "string", "description": "End date (YYYY-MM-DD)" }, { "disabled": false, "key": "include_crime_summary", "value": "true", "description": "Include summary statistics" }, { "disabled": false, "key": "include_crime_details", "value": "false", "description": "Include extended crime details" }, { "disabled": false, "key": "offense_categories", "value": "string", "description": "Filter by offense categories" }, { "disabled": false, "key": "offense_categories", "value": "string", "description": "Filter by offense categories" }, { "disabled": false, "key": "sort_by", "value": "recency", "description": "Sort order" }, { "disabled": false, "key": "limit", "value": "100", "description": "Maximum records to return" }, { "disabled": false, "key": "cursor", "value": "string", "description": "Pagination cursor" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "12418527-cd1a-48d0-88c0-89c4ac294820", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "radius_mi", "value": "1" }, { "key": "start_date", "value": "string" }, { "key": "end_date", "value": "string" }, { "key": "include_crime_summary", "value": "true" }, { "key": "include_crime_details", "value": "false" }, { "key": "offense_categories", "value": "string" }, { "key": "offense_categories", "value": "string" }, { "key": "sort_by", "value": "recency" }, { "key": "limit", "value": "100" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"query\": {\n \"lat\": 1258.8699173547768,\n \"lon\": 4794.932525706155,\n \"radius_mi\": 3644.0877513433857,\n \"include_crime_summary\": false,\n \"start\": \"string\",\n \"end\": \"string\",\n \"categories\": [\n \"string\",\n \"string\"\n ]\n },\n \"meta\": {\n \"count\": 298,\n \"truncated\": false,\n \"next_cursor\": \"string\",\n \"compute_ms\": 5082\n },\n \"crime_instances\": [\n {\n \"lat\": 119.70239741607492,\n \"lon\": 9531.52804259688,\n \"id\": 8358,\n \"datetime\": \"string\",\n \"distance_mi\": 3888.8374015539753,\n \"offense_code\": \"string\",\n \"offense_category\": \"string\",\n \"offense_description\": \"string\",\n \"severity\": \"string\",\n \"crime_type\": \"string\",\n \"address\": \"string\",\n \"agency\": \"string\",\n \"victim_sex\": \"string\",\n \"victim_race\": \"string\",\n \"victim_age_group\": \"string\",\n \"offender_sex\": \"string\",\n \"offender_race\": \"string\",\n \"offender_age_group\": \"string\",\n \"crime_against\": \"string\",\n \"reference_id\": \"string\"\n },\n {\n \"lat\": 726.452737205101,\n \"lon\": 1902.8012884388513,\n \"id\": 377,\n \"datetime\": \"string\",\n \"distance_mi\": 7604.400555149488,\n \"offense_code\": \"string\",\n \"offense_category\": \"string\",\n \"offense_description\": \"string\",\n \"severity\": \"string\",\n \"crime_type\": \"string\",\n \"address\": \"string\",\n \"agency\": \"string\",\n \"victim_sex\": \"string\",\n \"victim_race\": \"string\",\n \"victim_age_group\": \"string\",\n \"offender_sex\": \"string\",\n \"offender_race\": \"string\",\n \"offender_age_group\": \"string\",\n \"crime_against\": \"string\",\n \"reference_id\": \"string\"\n }\n ],\n \"summary\": {\n \"total\": 0,\n \"by_category\": {\n \"key_0\": 2006\n },\n \"by_severity\": {\n \"key_0\": 5777,\n \"key_1\": 6671\n }\n },\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 9123.677952526175,\n \"longitude\": 9143.351304669299,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3809a7e-9e76-418b-ab7f-2dd8945107dd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "radius_mi", "value": "1" }, { "key": "start_date", "value": "string" }, { "key": "end_date", "value": "string" }, { "key": "include_crime_summary", "value": "true" }, { "key": "include_crime_details", "value": "false" }, { "key": "offense_categories", "value": "string" }, { "key": "offense_categories", "value": "string" }, { "key": "sort_by", "value": "recency" }, { "key": "limit", "value": "100" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f99e213a-ee92-4a1b-8292-c642b2fa2cd6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "radius_mi", "value": "1" }, { "key": "start_date", "value": "string" }, { "key": "end_date", "value": "string" }, { "key": "include_crime_summary", "value": "true" }, { "key": "include_crime_details", "value": "false" }, { "key": "offense_categories", "value": "string" }, { "key": "offense_categories", "value": "string" }, { "key": "sort_by", "value": "recency" }, { "key": "limit", "value": "100" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81acb89-1c71-42ba-9197-459c8a67db2f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "radius_mi", "value": "1" }, { "key": "start_date", "value": "string" }, { "key": "end_date", "value": "string" }, { "key": "include_crime_summary", "value": "true" }, { "key": "include_crime_details", "value": "false" }, { "key": "offense_categories", "value": "string" }, { "key": "offense_categories", "value": "string" }, { "key": "sort_by", "value": "recency" }, { "key": "limit", "value": "100" }, { "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b39e8cfe-8938-4d99-a6e5-b0e1f03c724f", "name": "Get crime data (POST)", "request": { "name": "Get crime data (POST)", "description": { "content": "Get crime incident data within a radius from a location via POST request.\n \n Accepts JSON body with location and filter parameters.\n\n**API Credits:** 10 credits base. When incidents are returned via include_crime_details, add 1 credit per 5 incidents (rounded up). Example: 50 incidents = 10 + 10 = 20 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"radius_mi\": 1,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"include_crime_summary\": true,\n \"include_crime_details\": false,\n \"sort_by\": \"recency\",\n \"limit\": 100\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c85ec570-d7a2-4f3d-9c7a-07ef035abe29", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"radius_mi\": 1,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"include_crime_summary\": true,\n \"include_crime_details\": false,\n \"sort_by\": \"recency\",\n \"limit\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"query\": {\n \"lat\": 3158.756998152683,\n \"lon\": 9466.368163847794,\n \"radius_mi\": 6762.902315786652,\n \"include_crime_summary\": false,\n \"start\": \"string\",\n \"end\": \"string\",\n \"categories\": [\n \"string\",\n \"string\"\n ]\n },\n \"meta\": {\n \"count\": 9091,\n \"truncated\": false,\n \"next_cursor\": \"string\",\n \"compute_ms\": 7928\n },\n \"crime_instances\": [\n {\n \"lat\": 1718.1596927864985,\n \"lon\": 2906.1882749036517,\n \"id\": 6501,\n \"datetime\": \"string\",\n \"distance_mi\": 1444.8639428017307,\n \"offense_code\": \"string\",\n \"offense_category\": \"string\",\n \"offense_description\": \"string\",\n \"severity\": \"string\",\n \"crime_type\": \"string\",\n \"address\": \"string\",\n \"agency\": \"string\",\n \"victim_sex\": \"string\",\n \"victim_race\": \"string\",\n \"victim_age_group\": \"string\",\n \"offender_sex\": \"string\",\n \"offender_race\": \"string\",\n \"offender_age_group\": \"string\",\n \"crime_against\": \"string\",\n \"reference_id\": \"string\"\n },\n {\n \"lat\": 9817.382360196198,\n \"lon\": 909.7533063596463,\n \"id\": 2692,\n \"datetime\": \"string\",\n \"distance_mi\": 9091.596765845303,\n \"offense_code\": \"string\",\n \"offense_category\": \"string\",\n \"offense_description\": \"string\",\n \"severity\": \"string\",\n \"crime_type\": \"string\",\n \"address\": \"string\",\n \"agency\": \"string\",\n \"victim_sex\": \"string\",\n \"victim_race\": \"string\",\n \"victim_age_group\": \"string\",\n \"offender_sex\": \"string\",\n \"offender_race\": \"string\",\n \"offender_age_group\": \"string\",\n \"crime_against\": \"string\",\n \"reference_id\": \"string\"\n }\n ],\n \"summary\": {\n \"total\": 0,\n \"by_category\": {\n \"key_0\": 1239\n },\n \"by_severity\": {\n \"key_0\": 7579\n }\n },\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 4586.562177550031,\n \"longitude\": 2157.575892367267,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0f2190a-3133-4e38-9694-2ddf1615e801", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"radius_mi\": 1,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"include_crime_summary\": true,\n \"include_crime_details\": false,\n \"sort_by\": \"recency\",\n \"limit\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab180d01-f5c3-451b-97f6-6a74d2923d4e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"radius_mi\": 1,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"include_crime_summary\": true,\n \"include_crime_details\": false,\n \"sort_by\": \"recency\",\n \"limit\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf136d78-77e1-455e-ba3b-11352da261c0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"radius_mi\": 1,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"include_crime_summary\": true,\n \"include_crime_details\": false,\n \"sort_by\": \"recency\",\n \"limit\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1b2eacd9-d741-4f98-9bdb-62558363aee6", "name": "Fire Risk", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cd153823-30b2-4a0b-a936-f047028e7f29", "name": "Get wildfire risk by address or coordinates", "request": { "name": "Get wildfire risk by address or coordinates", "description": { "content": "Get wildfire risk assessment for a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Returns fire risk level, category, and probability information.\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "438bed44-891e-43bb-ae2f-0eb55da51621", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"789 Hillside Rd, Boulder, CO 80302\",\n \"latitude\": 40.015,\n \"longitude\": -105.27\n },\n \"fire_risk\": {\n \"has_fire_risk\": true,\n \"risk_value\": 0.0032,\n \"risk_level\": 7,\n \"risk_category\": \"high\",\n \"risk_category_display\": \"High\",\n \"description\": \"High wildfire risk area. Annual burn probability 1-in-312.\",\n \"annual_chance\": \"1-in-312\",\n \"return_period_years\": 312,\n \"data_source\": \"USDA Forest Service\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "164bd60a-0446-4c54-80c7-4ab9e905f29c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b796d47-e6c1-4442-a3ea-14f47804bc77", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81dc2d78-e8e0-4e26-a516-f56da4a3bc32", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc5a00e8-d6fc-4f62-95a5-2ec437eaca1f", "name": "Get wildfire risk (POST)", "request": { "name": "Get wildfire risk (POST)", "description": { "content": "Get wildfire risk assessment for a location via POST request.\n \n Accepts JSON body with location parameters.\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"string\",\n \"latitude\": -28.300839466584833,\n \"longitude\": 149.50306492200855,\n \"maps_api_response\": {\n \"key_0\": 5038.787169919677,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4fe7b9c0-9c1f-4718-84f4-2b18705ddfcb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"string\",\n \"latitude\": -28.300839466584833,\n \"longitude\": 149.50306492200855,\n \"maps_api_response\": {\n \"key_0\": 5038.787169919677,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"789 Hillside Rd, Boulder, CO 80302\",\n \"latitude\": 40.015,\n \"longitude\": -105.27\n },\n \"fire_risk\": {\n \"has_fire_risk\": true,\n \"risk_value\": 0.0032,\n \"risk_level\": 7,\n \"risk_category\": \"high\",\n \"risk_category_display\": \"High\",\n \"description\": \"High wildfire risk area. Annual burn probability 1-in-312.\",\n \"annual_chance\": \"1-in-312\",\n \"return_period_years\": 312,\n \"data_source\": \"USDA Forest Service\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0eb0583-e018-401e-9a55-98aaa7d2f2b0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"string\",\n \"latitude\": -28.300839466584833,\n \"longitude\": 149.50306492200855,\n \"maps_api_response\": {\n \"key_0\": 5038.787169919677,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdea072d-b644-49c1-943e-ff95ee1d69c1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"string\",\n \"latitude\": -28.300839466584833,\n \"longitude\": 149.50306492200855,\n \"maps_api_response\": {\n \"key_0\": 5038.787169919677,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceac69e7-01f5-4144-876b-f0c02b20f2ed", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"string\",\n \"latitude\": -28.300839466584833,\n \"longitude\": 149.50306492200855,\n \"maps_api_response\": {\n \"key_0\": 5038.787169919677,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4f45e894-22dc-4601-af18-b5f7d7a6013b", "name": "Socioeconomic Data", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f8115d85-38b2-47d0-b9a6-0ece08da0560", "name": "Get socioeconomic data by address or coordinates", "request": { "name": "Get socioeconomic data by address or coordinates", "description": { "content": "Get socioeconomic index data for a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Returns socioeconomic indices and natural hazard indices at multiple\n geography levels (county, cousub, tract, block_group) with various\n comparison bases (local, county, state, country).\n\n**API Credits:** 20 credits base with geographic multiplier: block group 1.0x (20), tract 0.9x (18), county subdivision 0.8x (16), county 0.7x (14), all geographies 2.5x (50).", "type": "text/plain" }, "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" }, { "disabled": false, "key": "year", "value": "2023", "description": "Data year (2019-2023)" }, { "disabled": false, "key": "geographies", "value": "all", "description": "Geography levels to include" }, { "disabled": false, "key": "include_grades", "value": "false", "description": "Include letter grades in response" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a18493b4-6315-4320-9650-c771a374d5f0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 311.829422784311,\n \"longitude\": 5363.325873419458,\n \"geohash8\": \"string\"\n },\n \"census_geoids\": {\n \"state_fips\": \"string\",\n \"county_fips\": \"string\",\n \"cousub_fips\": \"string\",\n \"tract_fips\": \"string\",\n \"block_fips\": \"string\"\n },\n \"socioeconomic\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 9887.18183206486,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 104.02099263337128,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 4303.478703771982,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 668.1629841535353,\n \"grade\": \"string\"\n }\n }\n }\n ],\n \"natural_hazards\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 3910.3091334934325,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 1037.3548670142952,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 3941.324173387979,\n \"grade\": \"string\"\n },\n \"key_2\": {\n \"value\": 3054.8150546437646,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 7253.444859490177,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 4026.9778777944975,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 6294.845266570741,\n \"grade\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a33c1213-907c-48d0-834c-9bb6cd262270", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5988a69-a5d7-49e5-9e2f-2b7cecb94049", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46996c80-b2c6-424a-8414-f7359680044e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "243d187b-cfba-4fde-894e-27eb9d0b3297", "name": "Get socioeconomic data (POST)", "request": { "name": "Get socioeconomic data (POST)", "description": { "content": "Get socioeconomic index data for a location via POST request.\n \n Accepts JSON body with location parameters.\n\n**API Credits:** 20 credits base with geographic multiplier: block group 1.0x (20), tract 0.9x (18), county subdivision 0.8x (16), county 0.7x (14), all geographies 2.5x (50).", "type": "text/plain" }, "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"year\": 2023,\n \"geographies\": [\n \"tract\",\n \"county\"\n ],\n \"include_grades\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "79fdd942-7bfd-476c-b052-97672c2bfa3e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"year\": 2023,\n \"geographies\": [\n \"tract\",\n \"county\"\n ],\n \"include_grades\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 7453.333721770004,\n \"longitude\": 2610.3073350020713,\n \"geohash8\": \"string\"\n },\n \"census_geoids\": {\n \"state_fips\": \"string\",\n \"county_fips\": \"string\",\n \"cousub_fips\": \"string\",\n \"tract_fips\": \"string\",\n \"block_fips\": \"string\"\n },\n \"socioeconomic\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 9656.826327845867,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 194.88762064844067,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 927.3567343901567,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 4464.421001047603,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 1797.3096097829066,\n \"grade\": \"string\"\n }\n }\n }\n ],\n \"natural_hazards\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 7131.120994156763,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 7086.973759989601,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 824.2061708090608,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 483.59735816112305,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 3401.4660747871894,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 7614.694125761832,\n \"grade\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f3330b4-6977-4392-b836-0c234eb5a77b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"year\": 2023,\n \"geographies\": [\n \"tract\",\n \"county\"\n ],\n \"include_grades\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3c21c4a-b33c-4dc6-a95d-cbea9ef1b787", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"year\": 2023,\n \"geographies\": [\n \"tract\",\n \"county\"\n ],\n \"include_grades\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b98f91f4-2857-407f-9a24-047c9c48d017", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"500 Congress Ave, Austin, TX 78701\",\n \"year\": 2023,\n \"geographies\": [\n \"tract\",\n \"county\"\n ],\n \"include_grades\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c004b99d-660a-420c-bec8-6f2ed6e91888", "name": "Get socioeconomic data by GEOID", "request": { "name": "Get socioeconomic data by GEOID", "description": { "content": "Get socioeconomic index data by Census GEOID.\n \n Parameters:\n - `geoid`: Census geographic identifier\n - `geography`: Geography level (county, cousub, tract, block_group)\n\n**API Credits:** 20 credits base with geographic multiplier.", "type": "text/plain" }, "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "geoid", "value": "string", "description": "(Required) Census GEOID" }, { "disabled": false, "key": "geography", "value": "block_group", "description": "(Required) Geography level of the GEOID" }, { "disabled": false, "key": "year", "value": "2023", "description": "Data year (2019-2023)" }, { "disabled": false, "key": "geographies", "value": "all", "description": "Geography levels to include in response" }, { "disabled": false, "key": "include_grades", "value": "false", "description": "Include letter grades in response" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "14f6b56c-0c59-4283-92cd-c2d1b8050ee3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "block_group" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 7453.333721770004,\n \"longitude\": 2610.3073350020713,\n \"geohash8\": \"string\"\n },\n \"census_geoids\": {\n \"state_fips\": \"string\",\n \"county_fips\": \"string\",\n \"cousub_fips\": \"string\",\n \"tract_fips\": \"string\",\n \"block_fips\": \"string\"\n },\n \"socioeconomic\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 9656.826327845867,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 194.88762064844067,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 927.3567343901567,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 4464.421001047603,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 1797.3096097829066,\n \"grade\": \"string\"\n }\n }\n }\n ],\n \"natural_hazards\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 7131.120994156763,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 7086.973759989601,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 824.2061708090608,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 483.59735816112305,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 3401.4660747871894,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 7614.694125761832,\n \"grade\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71add38e-576e-492b-8b6d-88be51436739", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "block_group" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af32733-9646-439a-abf9-08237940b0fb", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "block_group" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38d32352-b038-410e-a8e1-7aa78c08977b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "block_group" }, { "key": "year", "value": "2023" }, { "key": "geographies", "value": "all" }, { "key": "include_grades", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9cf16836-68e8-4bef-a0fb-ff403d6c6bcb", "name": "Natural Hazards", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8821e2a2-0e8b-4327-b5b3-b6b9151d3948", "name": "Natural Hazard Risk Indices", "request": { "name": "Natural Hazard Risk Indices", "description": { "content": "Get natural hazard risk indices (flood, storm surge, fire, etc.)\n for a location.\n \n Provide either:\n - ``address``: Full street address for geocoding\n - ``latitude`` + ``longitude``: Coordinate pair\n \n Returns hazard indices at county and tract geography levels.\n\n**API Credits:** 20 credits base with geographic multiplier: block group 1.0x (20), tract 0.9x (18), county subdivision 0.8x (16), county 0.7x (14), all geographies 2.5x (50).", "type": "text/plain" }, "url": { "path": [ "v1", "natural-hazards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "12.529791466608515", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "96.42330062093674", "description": "Longitude" }, { "disabled": false, "key": "year", "value": "2023", "description": "Data year" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4fbcd5ba-21a4-47fc-b7c9-13911b3d4a3f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "natural-hazards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "year", "value": "2023" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 6349,\n \"key_1\": true,\n \"key_2\": 661\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f790fa8e-3565-411f-bd52-826075660070", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "natural-hazards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "year", "value": "2023" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e4dbb9a6-9cde-41ca-800d-1a804ed45de8", "name": "AVM - Automated Valuation Models", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7373b080-bd12-4721-9959-ee1bca3e79d1", "name": "Property AVM Valuation", "request": { "name": "Property AVM Valuation", "description": { "content": "Get an automated property valuation (AVM) for a residential property.\n \n Returns:\n - Point estimate valuation\n - 95% confidence interval\n - Comparable properties with similarity scores\n - Per-model predictions from ensemble\n\n**API Credits:** 40 credits base + 1 per comparable returned. Default (5 comps) = 45 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1da5adb5-2728-48f3-a3fc-050c93e3cb36", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"formatted_address\": \"123 Main St, Austin, TX 78701\",\n \"city\": \"Austin\",\n \"state\": \"Texas\",\n \"state_code\": \"TX\",\n \"county\": \"Travis County\",\n \"postal_code\": \"78701\",\n \"latitude\": 30.2672,\n \"longitude\": -97.7431,\n \"geohash8\": \"9v6kn2pb\",\n \"census_geoids\": {\n \"state_fips\": \"48\",\n \"county_fips\": \"453\",\n \"tract_fips\": \"002100\",\n \"block_fips\": \"1\"\n }\n },\n \"valuation\": {\n \"point_value\": 412000,\n \"confidence_interval_95\": {\n \"low\": 381000,\n \"high\": 443000\n },\n \"probabilistic_distribution\": {\n \"p10\": 370000,\n \"p25\": 391000,\n \"p50\": 412000,\n \"p75\": 433000,\n \"p90\": 454000\n }\n },\n \"comparables\": {\n \"count\": 5,\n \"items\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bd0774b-8101-48d0-8555-01d42c00d7a7", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a8da117-c17a-4388-9b1a-7ec19864f396", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b414184-7459-4b35-8e06-95e99debf5c8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "482590d2-343a-40c3-97bc-5c411ec16cd2", "name": "Property AVM Valuation (GET)", "request": { "name": "Property AVM Valuation (GET)", "description": { "content": "Get property valuation using query parameters.\n\n**API Credits:** 40 credits base + 1 per comparable returned. Default (5 comps) = 45 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Property address" }, { "disabled": false, "key": "latitude", "value": "12.529791466608515", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "96.42330062093674", "description": "Longitude" }, { "disabled": false, "key": "total_bedrooms", "value": "31", "description": "(Required) Total bedrooms" }, { "disabled": false, "key": "total_bathrooms", "value": "33.93420667617482", "description": "(Required) Total bathrooms" }, { "disabled": false, "key": "living_area", "value": "8348", "description": "Living area sqft" }, { "disabled": false, "key": "lot_size", "value": "2608", "description": "Lot size sqft" }, { "disabled": false, "key": "year_built", "value": "1821", "description": "Year built" }, { "disabled": false, "key": "property_type", "value": "string", "description": "Property type (houses, townhomes, condos, small_multifamily)" }, { "disabled": false, "key": "total_units", "value": "2", "description": "Total units (1–4). Defaults to 2 for small_multifamily, 1 otherwise." }, { "disabled": false, "key": "walk_score", "value": "23", "description": "Walk score" }, { "disabled": false, "key": "has_pool", "value": "false", "description": "Has private pool" }, { "disabled": false, "key": "has_basement", "value": "false", "description": "Has basement" }, { "disabled": false, "key": "has_central_air", "value": "false", "description": "Has central air" }, { "disabled": false, "key": "garage_spaces", "value": "0", "description": "Number of garage spaces" }, { "disabled": false, "key": "num_stories", "value": "4", "description": "Number of stories" }, { "disabled": false, "key": "condition", "value": "0.9938562291365494", "description": "Condition score (1-5)" }, { "disabled": false, "key": "radius_mi", "value": "5", "description": "Search radius in miles" }, { "disabled": false, "key": "lookback_months", "value": "28", "description": "Months to look back for comparables" }, { "disabled": false, "key": "date", "value": "string", "description": "As-of date (YYYY-MM-DD)" }, { "disabled": false, "key": "num_comps", "value": "5", "description": "Number of comparables" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1ca3d5d1-f58b-46de-a32d-1c286a7149f7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "31" }, { "key": "total_bathrooms", "value": "33.93420667617482" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "23" }, { "key": "has_pool", "value": "false" }, { "key": "has_basement", "value": "false" }, { "key": "has_central_air", "value": "false" }, { "key": "garage_spaces", "value": "0" }, { "key": "num_stories", "value": "4" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"formatted_address\": \"123 Main St, Austin, TX 78701\",\n \"city\": \"Austin\",\n \"state\": \"Texas\",\n \"state_code\": \"TX\",\n \"county\": \"Travis County\",\n \"postal_code\": \"78701\",\n \"latitude\": 30.2672,\n \"longitude\": -97.7431,\n \"geohash8\": \"9v6kn2pb\",\n \"census_geoids\": {\n \"state_fips\": \"48\",\n \"county_fips\": \"453\",\n \"tract_fips\": \"002100\",\n \"block_fips\": \"1\"\n }\n },\n \"valuation\": {\n \"point_value\": 412000,\n \"confidence_interval_95\": {\n \"low\": 381000,\n \"high\": 443000\n },\n \"probabilistic_distribution\": {\n \"p10\": 370000,\n \"p25\": 391000,\n \"p50\": 412000,\n \"p75\": 433000,\n \"p90\": 454000\n }\n },\n \"comparables\": {\n \"count\": 5,\n \"items\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17c66bc2-f0d1-4f80-ac67-3c96457f2653", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "31" }, { "key": "total_bathrooms", "value": "33.93420667617482" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "23" }, { "key": "has_pool", "value": "false" }, { "key": "has_basement", "value": "false" }, { "key": "has_central_air", "value": "false" }, { "key": "garage_spaces", "value": "0" }, { "key": "num_stories", "value": "4" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6ef2a85-427e-415b-a530-f87dbbfb6a71", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "31" }, { "key": "total_bathrooms", "value": "33.93420667617482" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "23" }, { "key": "has_pool", "value": "false" }, { "key": "has_basement", "value": "false" }, { "key": "has_central_air", "value": "false" }, { "key": "garage_spaces", "value": "0" }, { "key": "num_stories", "value": "4" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0688c5bf-9d2d-4216-812d-917e78315e6c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "31" }, { "key": "total_bathrooms", "value": "33.93420667617482" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "23" }, { "key": "has_pool", "value": "false" }, { "key": "has_basement", "value": "false" }, { "key": "has_central_air", "value": "false" }, { "key": "garage_spaces", "value": "0" }, { "key": "num_stories", "value": "4" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb45b12d-545d-4429-b25b-f5e36c103851", "name": "Rental AVM Valuation", "request": { "name": "Rental AVM Valuation", "description": { "content": "Get an automated rental valuation (AVM) for rental units.\n \n Supports multiple units in a single request. Each unit can have\n different bedroom/bathroom configurations.\n \n Returns:\n - Point estimate rent for each unit\n - 95% confidence interval\n - Comparable rental listings with similarity scores\n - Per-model predictions from ensemble\n\n**API Credits:** 30 credits for first unit + 10 per additional unit + 1 per comparable. Single unit with 5 comps = 35 credits. 3 units with 5 comps = 55 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"456 Oak Ave, Tampa, FL 33602\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 1\n }\n ],\n \"property_type\": \"houses\"\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1feaa7dd-8579-42c7-b2ed-da0bc7fee4ce", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"456 Oak Ave, Tampa, FL 33602\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 1\n }\n ],\n \"property_type\": \"houses\"\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 3018.8232423735762,\n \"longitude\": 3576.6485865910113,\n \"geohash8\": \"string\",\n \"census_geoids\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n },\n \"valuation\": {\n \"key_0\": \"string\",\n \"key_1\": 195,\n \"key_2\": 1568.5828894471565\n },\n \"comparables\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50cbb73d-d220-4a9e-ba19-0b0450a0967b", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"456 Oak Ave, Tampa, FL 33602\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 1\n }\n ],\n \"property_type\": \"houses\"\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "431cdcbc-0c00-4eac-aa5b-0340ca73e473", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"456 Oak Ave, Tampa, FL 33602\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 1\n }\n ],\n \"property_type\": \"houses\"\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96c4e2ff-8bbd-4894-afd8-8698f2ec3817", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"456 Oak Ave, Tampa, FL 33602\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 1\n }\n ],\n \"property_type\": \"houses\"\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcfcf746-5761-41ba-94f9-f01ed987564f", "name": "Rental AVM Valuation (GET)", "request": { "name": "Rental AVM Valuation (GET)", "description": { "content": "Get rental valuation for a single unit using query parameters.\n\n**API Credits:** 30 credits base + 1 per comparable returned. Default (5 comps) = 35 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Property address" }, { "disabled": false, "key": "latitude", "value": "12.529791466608515", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "96.42330062093674", "description": "Longitude" }, { "disabled": false, "key": "bedrooms", "value": "3", "description": "(Required) Bedrooms in unit" }, { "disabled": false, "key": "bathrooms", "value": "8.645256138277178", "description": "(Required) Bathrooms in unit" }, { "disabled": false, "key": "size", "value": "670", "description": "Unit size sqft" }, { "disabled": false, "key": "fully_furnished", "value": "false", "description": "Is fully furnished" }, { "disabled": false, "key": "property_type", "value": "string", "description": "Property type (houses, townhomes, condos, small_multifamily, multifamily)" }, { "disabled": false, "key": "total_units", "value": "2496", "description": "Total units in building. Defaults to 2 for small_multifamily, 1 otherwise. Omit for multifamily to impute from neighbors." }, { "disabled": false, "key": "walk_score", "value": "23", "description": "Walk score" }, { "disabled": false, "key": "condition", "value": "0.9938562291365494", "description": "Condition score (1-5)" }, { "disabled": false, "key": "has_central_air", "value": "false", "description": "Has central air" }, { "disabled": false, "key": "in_unit_laundry", "value": "false", "description": "Has in-unit laundry" }, { "disabled": false, "key": "off_street_parking", "value": "true", "description": "Has off-street parking" }, { "disabled": false, "key": "radius_mi", "value": "5", "description": "Search radius in miles" }, { "disabled": false, "key": "lookback_months", "value": "28", "description": "Months to look back for comparables" }, { "disabled": false, "key": "date", "value": "string", "description": "As-of date (YYYY-MM-DD)" }, { "disabled": false, "key": "num_comps", "value": "5", "description": "Number of comparables" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fe5f0212-cb5d-4381-bcc6-21f8e93193e9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "8.645256138277178" }, { "key": "size", "value": "670" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2496" }, { "key": "walk_score", "value": "23" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "has_central_air", "value": "false" }, { "key": "in_unit_laundry", "value": "true" }, { "key": "off_street_parking", "value": "true" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 3018.8232423735762,\n \"longitude\": 3576.6485865910113,\n \"geohash8\": \"string\",\n \"census_geoids\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n },\n \"valuation\": {\n \"key_0\": \"string\",\n \"key_1\": 195,\n \"key_2\": 1568.5828894471565\n },\n \"comparables\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad38496f-ab48-4b5b-ac83-19c1ba5cd5cb", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "8.645256138277178" }, { "key": "size", "value": "670" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2496" }, { "key": "walk_score", "value": "23" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "has_central_air", "value": "false" }, { "key": "in_unit_laundry", "value": "true" }, { "key": "off_street_parking", "value": "true" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13d594a5-8710-4924-8885-746e75976f9a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "8.645256138277178" }, { "key": "size", "value": "670" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2496" }, { "key": "walk_score", "value": "23" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "has_central_air", "value": "true" }, { "key": "in_unit_laundry", "value": "true" }, { "key": "off_street_parking", "value": "true" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea86c40-1f24-4bad-ae37-46afed0896d1", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "8.645256138277178" }, { "key": "size", "value": "670" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2496" }, { "key": "walk_score", "value": "23" }, { "key": "condition", "value": "0.9938562291365494" }, { "key": "has_central_air", "value": "true" }, { "key": "in_unit_laundry", "value": "true" }, { "key": "off_street_parking", "value": "true" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9abee38-58fb-46d8-b82b-2a10d3694c0e", "name": "Multifamily AVM Valuation", "request": { "name": "Multifamily AVM Valuation", "description": { "content": "Get an automated property valuation (AVM) for multifamily properties.\n \n Designed for properties with 2+ units. Returns total property value\n based on building characteristics and comparable multifamily sales.\n \n Returns:\n - Point estimate valuation\n - 95% confidence interval\n - Comparable multifamily properties with similarity scores\n - Per-model predictions from ensemble\n\n**API Credits:** 60 credits base (2-4 units) or 80 credits base (2+ units) + 1 per comparable. Small MF with 5 comps = 65 credits. Large MF with 5 comps = 85 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 1215,\n \"bathrooms\": 4062.039487429958,\n \"total_units\": 732,\n \"living_area\": 9561,\n \"lot_size\": 8195,\n \"year_built\": 1942,\n \"property_type\": \"string\",\n \"num_stories\": 1354.6996861097273,\n \"condition_rating\": 2.6581477162168876\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "641f8b48-e6ac-4f83-bc9e-03f0082b1635", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 1215,\n \"bathrooms\": 4062.039487429958,\n \"total_units\": 732,\n \"living_area\": 9561,\n \"lot_size\": 8195,\n \"year_built\": 1942,\n \"property_type\": \"string\",\n \"num_stories\": 1354.6996861097273,\n \"condition_rating\": 2.6581477162168876\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"formatted_address\": \"456 Park Ave, New York, NY 10022\",\n \"latitude\": 40.7614,\n \"longitude\": -73.9716\n },\n \"valuation\": {\n \"total_units\": 12,\n \"point_value\": 4800000,\n \"estimated_value\": 4800000,\n \"estimated_value_low\": 3600000,\n \"estimated_value_high\": 6200000,\n \"confidence_interval_95\": {\n \"lower\": 3400000,\n \"upper\": 6500000\n },\n \"confidence_interval_90\": {\n \"lower\": 3600000,\n \"upper\": 6200000\n },\n \"price_per_unit\": 400000,\n \"price_per_unit_low\": 300000,\n \"price_per_unit_high\": 517000,\n \"probabilistic_distribution\": {\n \"mean\": 4800000,\n \"percentiles\": {\n \"p5\": 3600000,\n \"p10\": 3800000,\n \"p25\": 4200000,\n \"p50\": 4800000,\n \"p75\": 5400000,\n \"p90\": 5900000,\n \"p95\": 6200000\n }\n }\n },\n \"comparables\": {\n \"count\": 5,\n \"items\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe17b82-d706-4cac-aed1-76a3cdd45811", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 1215,\n \"bathrooms\": 4062.039487429958,\n \"total_units\": 732,\n \"living_area\": 9561,\n \"lot_size\": 8195,\n \"year_built\": 1942,\n \"property_type\": \"string\",\n \"num_stories\": 1354.6996861097273,\n \"condition_rating\": 2.6581477162168876\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "944fa348-377a-43d1-9772-c30dd9e63a1e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 1215,\n \"bathrooms\": 4062.039487429958,\n \"total_units\": 732,\n \"living_area\": 9561,\n \"lot_size\": 8195,\n \"year_built\": 1942,\n \"property_type\": \"string\",\n \"num_stories\": 1354.6996861097273,\n \"condition_rating\": 2.6581477162168876\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799eaf94-f5ea-43f2-acb0-9ce288047fd7", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 1215,\n \"bathrooms\": 4062.039487429958,\n \"total_units\": 732,\n \"living_area\": 9561,\n \"lot_size\": 8195,\n \"year_built\": 1942,\n \"property_type\": \"string\",\n \"num_stories\": 1354.6996861097273,\n \"condition_rating\": 2.6581477162168876\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62df8234-5975-4f77-87bc-6bf7a5d1ae15", "name": "Multifamily AVM Valuation (GET)", "request": { "name": "Multifamily AVM Valuation (GET)", "description": { "content": "Get multifamily valuation using query parameters.\n\n**API Credits:** 60 credits base (2-4 units) or 80 credits base (2+ units) + 1 per comparable returned.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "string", "description": "Property address" }, { "disabled": false, "key": "latitude", "value": "12.529791466608515", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "96.42330062093674", "description": "Longitude" }, { "disabled": false, "key": "total_bedrooms", "value": "38", "description": "(Required) Total bedrooms" }, { "disabled": false, "key": "total_bathrooms", "value": "88.48096158667114", "description": "(Required) Total bathrooms" }, { "disabled": false, "key": "total_units", "value": "202", "description": "(Required) Total units (must be 2-1000)" }, { "disabled": false, "key": "living_area", "value": "8348", "description": "Living area sqft" }, { "disabled": false, "key": "lot_size", "value": "2608", "description": "Lot size sqft" }, { "disabled": false, "key": "year_built", "value": "1821", "description": "Year built" }, { "disabled": false, "key": "walk_score", "value": "23", "description": "Walk score" }, { "disabled": false, "key": "num_stories", "value": "6175.903832797018", "description": "Number of stories" }, { "disabled": false, "key": "condition_rating", "value": "0.9938562291365494", "description": "Property condition rating (also accepts condition or condition_score)" }, { "disabled": false, "key": "radius_mi", "value": "5", "description": "Search radius in miles" }, { "disabled": false, "key": "lookback_months", "value": "28", "description": "Months to look back for comparables" }, { "disabled": false, "key": "date", "value": "string", "description": "As-of date (YYYY-MM-DD)" }, { "disabled": false, "key": "num_comps", "value": "5", "description": "Number of comparables" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2c275a71-3213-4e40-9934-46b6625c3301", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "38" }, { "key": "total_bathrooms", "value": "88.48096158667114" }, { "key": "total_units", "value": "202" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "walk_score", "value": "23" }, { "key": "num_stories", "value": "6175.903832797018" }, { "key": "condition_rating", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"formatted_address\": \"456 Park Ave, New York, NY 10022\",\n \"latitude\": 40.7614,\n \"longitude\": -73.9716\n },\n \"valuation\": {\n \"total_units\": 12,\n \"point_value\": 4800000,\n \"estimated_value\": 4800000,\n \"estimated_value_low\": 3600000,\n \"estimated_value_high\": 6200000,\n \"confidence_interval_95\": {\n \"lower\": 3400000,\n \"upper\": 6500000\n },\n \"confidence_interval_90\": {\n \"lower\": 3600000,\n \"upper\": 6200000\n },\n \"price_per_unit\": 400000,\n \"price_per_unit_low\": 300000,\n \"price_per_unit_high\": 517000,\n \"probabilistic_distribution\": {\n \"mean\": 4800000,\n \"percentiles\": {\n \"p5\": 3600000,\n \"p10\": 3800000,\n \"p25\": 4200000,\n \"p50\": 4800000,\n \"p75\": 5400000,\n \"p90\": 5900000,\n \"p95\": 6200000\n }\n }\n },\n \"comparables\": {\n \"count\": 5,\n \"items\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4985ee28-b646-4fa2-9d48-a05dd254804d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "38" }, { "key": "total_bathrooms", "value": "88.48096158667114" }, { "key": "total_units", "value": "202" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "walk_score", "value": "23" }, { "key": "num_stories", "value": "6175.903832797018" }, { "key": "condition_rating", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60e1e1c9-72b5-40b7-b105-3d0e66921175", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "38" }, { "key": "total_bathrooms", "value": "88.48096158667114" }, { "key": "total_units", "value": "202" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "walk_score", "value": "23" }, { "key": "num_stories", "value": "6175.903832797018" }, { "key": "condition_rating", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6db1288-3a8a-4f03-b193-dee34d23f096", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "12.529791466608515" }, { "key": "longitude", "value": "96.42330062093674" }, { "key": "total_bedrooms", "value": "38" }, { "key": "total_bathrooms", "value": "88.48096158667114" }, { "key": "total_units", "value": "202" }, { "key": "living_area", "value": "8348" }, { "key": "lot_size", "value": "2608" }, { "key": "year_built", "value": "1821" }, { "key": "walk_score", "value": "23" }, { "key": "num_stories", "value": "6175.903832797018" }, { "key": "condition_rating", "value": "0.9938562291365494" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "28" }, { "key": "date", "value": "string" }, { "key": "num_comps", "value": "5" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0c818fd-0c3c-4213-8b52-d6a50640e967", "name": "Property Batch AVM (Async)", "request": { "name": "Property Batch AVM (Async)", "description": { "content": "Submit a batch of residential properties for async valuation.\n\n Returns **202 Accepted** immediately with a `job_id`. Poll `status_url`\n for progress, or provide a `notify_url` to receive a POST when the job completes.\n\n - Max 500 properties per job\n - Each property runs the full AVM pipeline independently\n - Concurrency is controlled server-side to protect the DB connection pool\n - Partial failures are recorded per-property — one bad address does not fail the job\n\n**API Credits:** Same per-item cost as single property AVM (40 + comps per property). No batch discount. Example: 10 properties with 5 comps = 450 credits.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "batch", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37c6538b-d224-4a5d-a168-6689c13e2d1b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"string\",\n \"status\": \"failed\",\n \"avm_type\": \"string\",\n \"total\": 2734,\n \"status_url\": \"string\",\n \"created_at\": \"string\",\n \"notify_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9864d0b1-eb4d-4ef3-8aaf-8afbf3c8e0b4", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82549f3e-8712-4d05-852b-7676a7cf9647", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42cff3f4-2908-4bd3-9d29-36699eea654d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "property" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"living_area\": 1800,\n \"lot_size\": 7500,\n \"year_built\": 1998,\n \"property_type\": \"houses\",\n \"condition\": 3.5\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d08f201c-d779-4b83-8ce8-2f4375eafb29", "name": "Rental Batch AVM (Async)", "request": { "name": "Rental Batch AVM (Async)", "description": { "content": "Submit a batch of rental properties for async valuation.\n\n Returns **202 Accepted** immediately with a `job_id`. Poll `status_url`\n for progress, or provide a `notify_url` to receive a POST when the job completes.\n\n**API Credits:** Same per-item cost as single rental AVM (30 + units + comps per property). No batch discount.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "batch", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 5.583433607306906,\n \"size\": 1007,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 2816,\n \"condition\": 4.500145337192304,\n \"has_central_air\": true,\n \"has_laundry\": false,\n \"has_parking\": false\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0fb1b8e9-646d-4d4d-a1bf-33e7506b0458", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 5.583433607306906,\n \"size\": 1007,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 2816,\n \"condition\": 4.500145337192304,\n \"has_central_air\": true,\n \"has_laundry\": false,\n \"has_parking\": false\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"string\",\n \"status\": \"failed\",\n \"avm_type\": \"string\",\n \"total\": 2734,\n \"status_url\": \"string\",\n \"created_at\": \"string\",\n \"notify_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "649cc365-c066-4471-8862-a1d8c92b763d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 5.583433607306906,\n \"size\": 1007,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 2816,\n \"condition\": 4.500145337192304,\n \"has_central_air\": true,\n \"has_laundry\": false,\n \"has_parking\": false\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc136915-6eec-4d0a-984d-3b418e61c665", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 5.583433607306906,\n \"size\": 1007,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 2816,\n \"condition\": 4.500145337192304,\n \"has_central_air\": true,\n \"has_laundry\": false,\n \"has_parking\": false\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07cafcb8-c9e6-4b83-a56e-4574ff864255", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "rental" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"units\": [\n {\n \"bedrooms\": 2,\n \"bathrooms\": 5.583433607306906,\n \"size\": 1007,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 2816,\n \"condition\": 4.500145337192304,\n \"has_central_air\": true,\n \"has_laundry\": false,\n \"has_parking\": false\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5242c61c-84ac-4fe2-8fd5-1ff083ebc2d5", "name": "Multifamily Batch AVM (Async)", "request": { "name": "Multifamily Batch AVM (Async)", "description": { "content": "Submit a batch of multifamily properties for async valuation.\n\n Returns **202 Accepted** immediately with a `job_id`. Poll `status_url`\n for progress, or provide a `notify_url` to receive a POST when the job completes.\n\n**API Credits:** Same per-item cost as single multifamily AVM (60-80 + comps per property). No batch discount.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "batch", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 4150,\n \"bathrooms\": 2696.2690324605587,\n \"total_units\": 837,\n \"living_area\": 2660,\n \"lot_size\": 73,\n \"year_built\": 1977,\n \"property_type\": \"string\",\n \"num_stories\": 7196.61523441589,\n \"condition_rating\": 4.395431365019005\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fd29cee9-9351-44e2-8c66-e492ff12ac4e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 4150,\n \"bathrooms\": 2696.2690324605587,\n \"total_units\": 837,\n \"living_area\": 2660,\n \"lot_size\": 73,\n \"year_built\": 1977,\n \"property_type\": \"string\",\n \"num_stories\": 7196.61523441589,\n \"condition_rating\": 4.395431365019005\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"string\",\n \"status\": \"failed\",\n \"avm_type\": \"string\",\n \"total\": 2734,\n \"status_url\": \"string\",\n \"created_at\": \"string\",\n \"notify_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "708c1cd0-1c1b-460d-91a5-934c67331008", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 4150,\n \"bathrooms\": 2696.2690324605587,\n \"total_units\": 837,\n \"living_area\": 2660,\n \"lot_size\": 73,\n \"year_built\": 1977,\n \"property_type\": \"string\",\n \"num_stories\": 7196.61523441589,\n \"condition_rating\": 4.395431365019005\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0a33b8f-979f-4c39-a519-52221c677123", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 4150,\n \"bathrooms\": 2696.2690324605587,\n \"total_units\": 837,\n \"living_area\": 2660,\n \"lot_size\": 73,\n \"year_built\": 1977,\n \"property_type\": \"string\",\n \"num_stories\": 7196.61523441589,\n \"condition_rating\": 4.395431365019005\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad0a75cd-ae05-4062-ad1a-b1a499f309e0", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": [\n {\n \"location\": {\n \"address\": \"123 Main St, Austin, TX 78701\"\n },\n \"property_fields\": {\n \"bedrooms\": 4150,\n \"bathrooms\": 2696.2690324605587,\n \"total_units\": 837,\n \"living_area\": 2660,\n \"lot_size\": 73,\n \"year_built\": 1977,\n \"property_type\": \"string\",\n \"num_stories\": 7196.61523441589,\n \"condition_rating\": 4.395431365019005\n },\n \"property_id\": \"string\",\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n }\n ],\n \"notify_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c99d650-5aeb-4f83-9b36-6d44edd78d35", "name": "Batch Job Status", "request": { "name": "Batch Job Status", "description": { "content": "Poll the status of an async batch valuation job.\n\n **While processing:** returns `status`, `completed`, `failed`, and `progress_pct`.\n\n **When complete:** also returns the full `results` array, one entry per\n input property in the original submission order. Each entry contains:\n - `index` — zero-based position in the input list\n - `property_id` — echoed from the submission if provided\n - `status` — `\"complete\"` or `\"error\"`\n - `data` — full AVM response payload (when status is `\"complete\"`)\n - `error` — error message (when status is `\"error\"`)\n\n If a `notify_url` was provided at submission, `webhook_delivered` indicates\n whether the POST callback succeeded.", "type": "text/plain" }, "url": { "path": [ "v1", "avm", "batch", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2958c78f-650e-4329-9205-43bb588bd434", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"string\",\n \"status\": \"processing\",\n \"avm_type\": \"string\",\n \"total\": 7751,\n \"completed\": 8038,\n \"failed\": 2630,\n \"progress_pct\": 3322.4129640419565,\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"completed_at\": \"string\",\n \"notify_url\": \"string\",\n \"webhook_delivered\": true,\n \"results\": [\n {\n \"key_0\": 1944.2945179559667,\n \"key_1\": 440.15105518216524\n },\n {\n \"key_0\": 2119.453784380885\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ed2c512-6ce3-432b-876a-a2f765d6b138", "name": "Job not found", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b4df67a-fa31-4b04-be96-6cf44fcc37fc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "401c4c56-1c5b-4915-aa7f-e798a278e5e0", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "batch", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "225eb81f-7e34-43cb-ac77-c58b09369aaa", "name": "Sinkhole Risk", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "79307a41-e418-4a7c-bb1c-0bb125689ef9", "name": "Get sinkhole risk by address or coordinates", "request": { "name": "Get sinkhole risk by address or coordinates", "description": { "content": "Get sinkhole risk assessment for a location.\n \n Provide either:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n \n Returns sinkhole susceptibility index (SSI) score and risk level.\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "address", "value": "123 Main St, Orlando, FL 32801", "description": "Full street address" }, { "disabled": false, "key": "latitude", "value": "-45.49882308251177", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "19.58037144208842", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "857f1e14-474d-458b-a910-e5999ee7f039", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sinkhole_risk\": {\n \"in_risk_zone\": true,\n \"ssi_score\": 6626.137653079738,\n \"risk_level\": 0,\n \"risk_label\": \"moderate\",\n \"resolution_m\": 5539,\n \"methodology_version\": \"string\"\n },\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 2148.2959321713756,\n \"longitude\": 2524.0424550020025,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dee16884-2870-4695-89ec-7bfd81d6bff8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4042d94-19c9-40a6-84e6-d9a22937dc2e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75945a1e-c9bc-45da-b86f-4886ce510334", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "-45.49882308251177" }, { "key": "longitude", "value": "19.58037144208842" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f3577e6-5435-4a7d-ae5f-338d20d236ac", "name": "Get sinkhole risk (POST)", "request": { "name": "Get sinkhole risk (POST)", "description": { "content": "Get sinkhole risk assessment for a location via POST request.\n \n Accepts JSON body with:\n - `address`: Full street address for geocoding\n - `latitude` + `longitude`: Coordinate pair\n - `maps_api_response`: Pre-fetched Google Maps geocoding response\n\n**API Credits:** 10 credits per request.", "type": "text/plain" }, "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main St, Orlando, FL 32801\",\n \"latitude\": 54.45453242073518,\n \"longitude\": 1.2095767600473266,\n \"maps_api_response\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aea76fa2-582b-414d-bd0f-5a0d2aba5888", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main St, Orlando, FL 32801\",\n \"latitude\": 54.45453242073518,\n \"longitude\": 1.2095767600473266,\n \"maps_api_response\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sinkhole_risk\": {\n \"in_risk_zone\": true,\n \"ssi_score\": 6626.137653079738,\n \"risk_level\": 0,\n \"risk_label\": \"moderate\",\n \"resolution_m\": 5539,\n \"methodology_version\": \"string\"\n },\n \"location_info\": {\n \"formatted_address\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"state_code\": \"string\",\n \"county\": \"string\",\n \"postal_code\": \"string\",\n \"latitude\": 2148.2959321713756,\n \"longitude\": 2524.0424550020025,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5861f918-2939-43bc-a6ca-ad108c31f418", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main St, Orlando, FL 32801\",\n \"latitude\": 54.45453242073518,\n \"longitude\": 1.2095767600473266,\n \"maps_api_response\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c6348ad-4518-4ed6-9104-12149d089145", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main St, Orlando, FL 32801\",\n \"latitude\": 54.45453242073518,\n \"longitude\": 1.2095767600473266,\n \"maps_api_response\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a448fcfa-5b87-47e8-8014-7b2de2f7a483", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"123 Main St, Orlando, FL 32801\",\n \"latitude\": 54.45453242073518,\n \"longitude\": 1.2095767600473266,\n \"maps_api_response\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9682ff7e-d19f-48f5-9536-7b997b0c0f02", "name": "Comprehensive", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c010ca63-1a4d-4b2a-9726-2b7cb56ccd2c", "name": "Comprehensive Multi-Service Endpoint", "request": { "name": "Comprehensive Multi-Service Endpoint", "description": { "content": "Request multiple data types in a single API call.\n \n Specify which services you need in the `requests` array:\n - `property-avm` - Property valuation (requires beds, baths)\n - `rental-avm` - Rental valuation (requires units or beds/baths)\n - `multifamily-avm` - Multifamily valuation (requires total_units >= 5, beds, baths)\n - `socioeconomic` - Socioeconomic indices\n - `natural-hazards` - Combined hazard risk data\n - `flood-zone` - FEMA flood zone information\n - `storm-surge` - Hurricane storm surge risk\n - `fire-risk` - Wildfire risk assessment\n - `crime-data` - Local crime statistics\n - `census-data` - ACS census data\n \n Only include fields relevant to your requested services.\n \n Example request:\n ```json\n {\n \"address\": \"123 Main St, Tampa, FL\",\n \"requests\": [\"property-avm\", \"flood-zone\"],\n \"beds\": 3,\n \"baths\": 2\n }\n ```\n\n**API Credits:** Sum of credits for each requested service. See Credits and Pricing guide for per-endpoint costs.", "type": "text/plain" }, "url": { "path": [ "v1", "comprehensive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"requests\": [\n \"rental-avm\"\n ],\n \"address\": \"string\",\n \"latitude\": -77.83269748808351,\n \"longitude\": -1.934255825473798,\n \"beds\": 45,\n \"baths\": 16.325005443496853,\n \"living_area\": 2868,\n \"lot_size\": 820,\n \"year_built\": 1984,\n \"property_type\": \"string\",\n \"total_units\": 572,\n \"condition\": 8037.736934119064,\n \"porch\": false,\n \"deck\": false,\n \"pool\": false,\n \"basement\": false,\n \"adu\": false,\n \"patio\": false,\n \"balcony\": true,\n \"central_air\": true,\n \"in_unit_laundry\": true,\n \"fireplace_count\": 9,\n \"garage_spaces\": 4,\n \"other_spaces\": 6,\n \"num_stories\": 4986,\n \"walk_score\": 21,\n \"month_sold\": 5,\n \"year_sold\": 1912,\n \"units\": [\n {\n \"beds\": 2,\n \"baths\": 4.277734156849067,\n \"living_area\": 4069,\n \"furnished\": false\n },\n {\n \"beds\": 8,\n \"baths\": 4.012936084922503,\n \"living_area\": 3613,\n \"furnished\": false\n }\n ],\n \"furnished\": false,\n \"laundry\": true,\n \"parking\": false,\n \"mixed_use\": true,\n \"date\": \"string\",\n \"lookback_months\": 11,\n \"radius_mi\": 13.11191800007749,\n \"num_comparables\": 20,\n \"include_grades\": true,\n \"year\": 2021,\n \"geographies\": [\n \"string\",\n \"string\"\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ],\n \"years\": [\n 6849,\n 3438\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": false,\n \"include_crime_details\": false,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 307\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2fe40cc2-c3ed-4386-b73b-f7a2c630c31d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "comprehensive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n \"census-data\"\n ],\n \"address\": \"string\",\n \"latitude\": 77.81659161995154,\n \"longitude\": -98.37030329120208,\n \"beds\": 25,\n \"baths\": 23.41565926788207,\n \"living_area\": 580,\n \"lot_size\": 841,\n \"year_built\": 1822,\n \"property_type\": \"string\",\n \"total_units\": 558,\n \"condition\": 8280.735587737578,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": true,\n \"adu\": false,\n \"patio\": false,\n \"balcony\": true,\n \"central_air\": false,\n \"in_unit_laundry\": true,\n \"fireplace_count\": 5,\n \"garage_spaces\": 6,\n \"other_spaces\": 2,\n \"num_stories\": 7880,\n \"walk_score\": 11,\n \"month_sold\": 6,\n \"year_sold\": 2010,\n \"units\": [\n {\n \"beds\": 1,\n \"baths\": 1.3939016674909488,\n \"living_area\": 487,\n \"furnished\": false\n },\n {\n \"beds\": 1,\n \"baths\": 4.3125160833712295,\n \"living_area\": 8183,\n \"furnished\": false\n }\n ],\n \"furnished\": false,\n \"laundry\": false,\n \"parking\": true,\n \"mixed_use\": true,\n \"date\": \"string\",\n \"lookback_months\": 17,\n \"radius_mi\": 2.159057456823041,\n \"num_comparables\": 27,\n \"include_grades\": false,\n \"year\": 2021,\n \"geographies\": [\n \"string\",\n \"string\"\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ],\n \"years\": [\n 2498,\n 4367\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": true,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 92\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"key_0\": 1386.2126821350462\n },\n \"property_avm\": {\n \"key_0\": 3933.101849856815\n },\n \"rental_avm\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": 4885,\n \"key_3\": 2328\n },\n \"multifamily_avm\": {\n \"key_0\": 4052,\n \"key_1\": false\n },\n \"census_data\": {\n \"key_0\": 3794.589587102639\n },\n \"location_data\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"metadata\": {\n \"api_version\": \"v1.0.0\",\n \"compute_ms\": 3801,\n \"request_id\": \"string\",\n \"response_timestamp\": \"string\",\n \"credits_used\": 3944,\n \"credits_breakdown\": {\n \"key_0\": 7420\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f39f9c40-57ae-4dc7-8f8d-a4c8226025db", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "comprehensive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n \"census-data\"\n ],\n \"address\": \"string\",\n \"latitude\": 77.81659161995154,\n \"longitude\": -98.37030329120208,\n \"beds\": 25,\n \"baths\": 23.41565926788207,\n \"living_area\": 580,\n \"lot_size\": 841,\n \"year_built\": 1822,\n \"property_type\": \"string\",\n \"total_units\": 558,\n \"condition\": 8280.735587737578,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": true,\n \"adu\": false,\n \"patio\": false,\n \"balcony\": true,\n \"central_air\": false,\n \"in_unit_laundry\": true,\n \"fireplace_count\": 5,\n \"garage_spaces\": 6,\n \"other_spaces\": 2,\n \"num_stories\": 7880,\n \"walk_score\": 11,\n \"month_sold\": 6,\n \"year_sold\": 2010,\n \"units\": [\n {\n \"beds\": 1,\n \"baths\": 1.3939016674909488,\n \"living_area\": 487,\n \"furnished\": false\n },\n {\n \"beds\": 1,\n \"baths\": 4.3125160833712295,\n \"living_area\": 8183,\n \"furnished\": false\n }\n ],\n \"furnished\": false,\n \"laundry\": false,\n \"parking\": true,\n \"mixed_use\": true,\n \"date\": \"string\",\n \"lookback_months\": 17,\n \"radius_mi\": 2.159057456823041,\n \"num_comparables\": 27,\n \"include_grades\": false,\n \"year\": 2021,\n \"geographies\": [\n \"string\",\n \"string\"\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ],\n \"years\": [\n 2498,\n 4367\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": true,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 92\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a77533dc-117c-457b-96ca-6c245d25682c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "comprehensive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n \"census-data\"\n ],\n \"address\": \"string\",\n \"latitude\": 77.81659161995154,\n \"longitude\": -98.37030329120208,\n \"beds\": 25,\n \"baths\": 23.41565926788207,\n \"living_area\": 580,\n \"lot_size\": 841,\n \"year_built\": 1822,\n \"property_type\": \"string\",\n \"total_units\": 558,\n \"condition\": 8280.735587737578,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": true,\n \"adu\": false,\n \"patio\": false,\n \"balcony\": true,\n \"central_air\": false,\n \"in_unit_laundry\": true,\n \"fireplace_count\": 5,\n \"garage_spaces\": 6,\n \"other_spaces\": 2,\n \"num_stories\": 7880,\n \"walk_score\": 11,\n \"month_sold\": 6,\n \"year_sold\": 2010,\n \"units\": [\n {\n \"beds\": 1,\n \"baths\": 1.3939016674909488,\n \"living_area\": 487,\n \"furnished\": false\n },\n {\n \"beds\": 1,\n \"baths\": 4.3125160833712295,\n \"living_area\": 8183,\n \"furnished\": false\n }\n ],\n \"furnished\": false,\n \"laundry\": false,\n \"parking\": true,\n \"mixed_use\": true,\n \"date\": \"string\",\n \"lookback_months\": 17,\n \"radius_mi\": 2.159057456823041,\n \"num_comparables\": 27,\n \"include_grades\": false,\n \"year\": 2021,\n \"geographies\": [\n \"string\",\n \"string\"\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ],\n \"years\": [\n 2498,\n 4367\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": true,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 92\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"string\",\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2deb5606-346c-423a-ac78-5e04586fdb0a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "comprehensive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n \"census-data\"\n ],\n \"address\": \"string\",\n \"latitude\": 77.81659161995154,\n \"longitude\": -98.37030329120208,\n \"beds\": 25,\n \"baths\": 23.41565926788207,\n \"living_area\": 580,\n \"lot_size\": 841,\n \"year_built\": 1822,\n \"property_type\": \"string\",\n \"total_units\": 558,\n \"condition\": 8280.735587737578,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": true,\n \"adu\": false,\n \"patio\": false,\n \"balcony\": true,\n \"central_air\": false,\n \"in_unit_laundry\": true,\n \"fireplace_count\": 5,\n \"garage_spaces\": 6,\n \"other_spaces\": 2,\n \"num_stories\": 7880,\n \"walk_score\": 11,\n \"month_sold\": 6,\n \"year_sold\": 2010,\n \"units\": [\n {\n \"beds\": 1,\n \"baths\": 1.3939016674909488,\n \"living_area\": 487,\n \"furnished\": false\n },\n {\n \"beds\": 1,\n \"baths\": 4.3125160833712295,\n \"living_area\": 8183,\n \"furnished\": false\n }\n ],\n \"furnished\": false,\n \"laundry\": false,\n \"parking\": true,\n \"mixed_use\": true,\n \"date\": \"string\",\n \"lookback_months\": 17,\n \"radius_mi\": 2.159057456823041,\n \"num_comparables\": 27,\n \"include_grades\": false,\n \"year\": 2021,\n \"geographies\": [\n \"string\",\n \"string\"\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ],\n \"years\": [\n 2498,\n 4367\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": true,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 92\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.padstats.io", "type": "string" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "YOUR_API_KEY", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "info": { "_postman_id": "b9d3d81f-afa0-4a82-a28f-85a669b76238", "name": "PadStats Intelligence API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Property valuation and location intelligence API.\n\n## Authentication\nAll endpoints require an API key passed via the `X-API-Key` header.\n\n```\nX-API-Key: YOUR_API_KEY\n```\n\nSign up at [dashboard.padstats.io](https://dashboard.padstats.io) to get your key.", "type": "text/plain" } } }