{ "item": [ { "id": "f90e6f6b-13f8-46dc-8201-57dcc92a3584", "name": "Health", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "aca10f90-a7b0-4217-a37b-9c1723ec9098", "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": "d88c83cf-0c6c-42a3-93c9-03cb2575cbd2", "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": "f7a9859e-72a2-4d9b-8cd7-bdbccf44421e", "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": "eea7f8e1-abe9-43b2-ba64-3ca81b32253b", "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": "6f84d94f-1b59-4946-abec-bf947e7bd49a", "name": "Storm Surge", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "22625eed-9128-4edd-844f-aeb9686c52b4", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cf720ccd-4514-42fe-8eeb-6ce76f23487f", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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\": true,\n \"zones\": [\n {\n \"category\": 4,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 3,\n \"depth_ft\": 2036\n },\n {\n \"category\": 1,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 1,\n \"depth_ft\": 4644\n }\n ],\n \"highest_risk_level\": 2,\n \"highest_risk_category\": \"string\",\n \"max_surge_depth_ft\": 6290\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\": 2146.4251340770634,\n \"longitude\": 2008.1817172821848,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d672aeca-ee3d-415a-96b2-dcb0761ba6a1", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "73ba67ec-2198-4976-90eb-d9665127a19e", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "48e146c1-4c41-491f-992a-30eba8cc658a", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "aa03b709-09d7-4db7-928e-805be3fe2181", "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\": -21.558371819513482,\n \"longitude\": -167.84628938118533,\n \"maps_api_response\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30f0b041-7e18-42f9-900e-c47be0a1d89a", "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\": -21.558371819513482,\n \"longitude\": -167.84628938118533,\n \"maps_api_response\": {\n \"key_0\": \"string\"\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\": 1,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 1,\n \"depth_ft\": 560\n },\n {\n \"category\": 1,\n \"depth_category\": \"3-6 ft\",\n \"risk_level\": 0,\n \"depth_ft\": 4076\n }\n ],\n \"highest_risk_level\": 2,\n \"highest_risk_category\": \"string\",\n \"max_surge_depth_ft\": 2415\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\": 2635.3616680914406,\n \"longitude\": 8721.060245962475,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32e33b65-ba33-4c1e-b96c-1204e8e84082", "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\": -21.558371819513482,\n \"longitude\": -167.84628938118533,\n \"maps_api_response\": {\n \"key_0\": \"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": "54d6b198-c24f-469a-a60c-de4d2f6b656e", "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\": -21.558371819513482,\n \"longitude\": -167.84628938118533,\n \"maps_api_response\": {\n \"key_0\": \"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": "9f21565d-728c-47fd-ad16-f4d66865cdff", "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\": -21.558371819513482,\n \"longitude\": -167.84628938118533,\n \"maps_api_response\": {\n \"key_0\": \"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": "f030274d-d33e-4316-a7fb-a819980ae905", "name": "Flood Zone", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "33dd4b61-280d-40d7-85de-5aef5f23044f", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "61d5e0dd-1ebe-4504-8ce4-40cb339d54e1", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "18ee1939-b1fa-45e7-9b4c-36535e227408", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "c9f34b48-961d-4508-81c0-2fc98c038990", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "5689ed87-4d24-4368-bf9a-1cb7a49f53ce", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "48ab523e-c9c8-4d0a-9fd7-173275db104d", "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\": -53.37210227687478,\n \"longitude\": -29.541941154223025,\n \"maps_api_response\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d941451-f603-4a2f-a12f-af9028f14031", "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\": -53.37210227687478,\n \"longitude\": -29.541941154223025,\n \"maps_api_response\": {\n \"key_0\": \"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": "bd793ffe-7b21-4d34-9e30-3779605be691", "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\": -53.37210227687478,\n \"longitude\": -29.541941154223025,\n \"maps_api_response\": {\n \"key_0\": \"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": "d670f0ab-fcd0-4d78-9686-a2e23ecba60a", "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\": -53.37210227687478,\n \"longitude\": -29.541941154223025,\n \"maps_api_response\": {\n \"key_0\": \"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": "b97a9a19-cb8b-42bf-93c9-8be46e7fed5a", "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\": -53.37210227687478,\n \"longitude\": -29.541941154223025,\n \"maps_api_response\": {\n \"key_0\": \"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": "bdf4eec7-9336-4804-b2fd-37594e51c627", "name": "Census Data", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "016f1bb8-659a-4f1e-ba28-fac7a78e7295", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "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": "88cb066e-3c10-43e2-a035-7451c977e127", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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\": 4953.000434417203,\n \"longitude\": 5053.112808102897,\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\": 1039,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 236.60999030876485,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 7587.661245990591,\n \"base_variable\": \"string\"\n }\n }\n },\n {\n \"year\": 2185,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 2331.735463494582,\n \"base_variable\": \"string\"\n }\n }\n }\n ],\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec20b55e-9950-47ff-9577-b12b0f85da9f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "a0b415d9-e072-45e1-add3-cc2c088de56e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "77f84bba-f28f-4341-85d3-b4c35b6adb5e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "census-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "a8158ed2-d9ed-41f1-a2b6-9699c01058a8", "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": "037661c1-5916-4b54-ba05-3c408b10d4e7", "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\": 23.21654243294597,\n \"longitude\": -98.39282007317254,\n \"maps_api_response\": {\n \"key_0\": true,\n \"key_1\": 1073\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\": 1647.7121241565085,\n \"longitude\": 3274.352357236039,\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\": 3225,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 4480.421670153276,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 429.1475481154028,\n \"base_variable\": \"string\"\n }\n }\n },\n {\n \"year\": 3656,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 6287.578685740689,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 979.1661980848088,\n \"base_variable\": \"string\"\n }\n }\n }\n ],\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79ae85c3-8d42-4ed2-8d21-c7e1dfb9b19a", "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\": 23.21654243294597,\n \"longitude\": -98.39282007317254,\n \"maps_api_response\": {\n \"key_0\": true,\n \"key_1\": 1073\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": "421f22ff-9c41-4143-8c55-9b734da1707c", "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\": 23.21654243294597,\n \"longitude\": -98.39282007317254,\n \"maps_api_response\": {\n \"key_0\": true,\n \"key_1\": 1073\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": "a4079a9c-a291-453c-abe9-25bd32567238", "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\": 23.21654243294597,\n \"longitude\": -98.39282007317254,\n \"maps_api_response\": {\n \"key_0\": true,\n \"key_1\": 1073\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": "95cbdcd1-3eca-4234-84ae-a023ce9ae9c7", "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\": \"block_group\",\n \"years\": [\n 2023\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9476d93f-364b-4369-8b09-af3d51f967be", "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\": 1647.7121241565085,\n \"longitude\": 3274.352357236039,\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\": 3225,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 4480.421670153276,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 429.1475481154028,\n \"base_variable\": \"string\"\n }\n }\n },\n {\n \"year\": 3656,\n \"geography_level\": \"string\",\n \"variables\": {\n \"key_0\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 6287.578685740689,\n \"base_variable\": \"string\"\n },\n \"key_1\": {\n \"category\": \"demographics\",\n \"subcategory\": \"age\",\n \"value_type\": \"percentage\",\n \"value\": 979.1661980848088,\n \"base_variable\": \"string\"\n }\n }\n }\n ],\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0009c0c1-ba57-4baf-bcb7-d596ba1b0149", "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": "f97f0d72-a71d-4b06-ae3d-519ec3f0a151", "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": "89dd1245-c858-417a-904f-5edd9a77b53d", "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": "a7d2b8ad-221c-4aca-a3e0-0dd274a7f4ff", "name": "Crime Data", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "57828f3c-918e-4cd2-9860-936a04debc28", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "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": "69209514-5ad4-4630-9a34-8594dd0cfe0b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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\": 3860.0523121698548,\n \"lon\": 4993.27169805597,\n \"radius_mi\": 1271.143504371699,\n \"include_crime_summary\": false,\n \"start\": \"string\",\n \"end\": \"string\",\n \"categories\": [\n \"string\",\n \"string\"\n ]\n },\n \"meta\": {\n \"count\": 3591,\n \"truncated\": false,\n \"next_cursor\": \"string\",\n \"compute_ms\": 8081\n },\n \"crime_instances\": [\n {\n \"lat\": 6244.4636079604825,\n \"lon\": 9915.936707929823,\n \"id\": 7876,\n \"datetime\": \"string\",\n \"distance_mi\": 8536.190149895609,\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\": 3525.6296662994814,\n \"lon\": 6774.945203572431,\n \"id\": 5083,\n \"datetime\": \"string\",\n \"distance_mi\": 1666.7880193974827,\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\": 8746,\n \"key_1\": 8826\n },\n \"by_severity\": {\n \"key_0\": 9782,\n \"key_1\": 8856\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\": 5141.375337136005,\n \"longitude\": 7824.157305059564,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9ef10cc-f98f-4340-9d05-782fb6a17cfd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "e8a120f3-a3c9-4df4-aeff-268e1ad82d1d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "48a30634-2dcf-4af8-97e5-d58ab6f4310b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "crime-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "1cda2277-e02a-409a-bcb1-b4143713275b", "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": "26a1c8ac-11cf-45c4-a5cd-fda5e21d98cd", "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\": 1175.1010769277027,\n \"lon\": 1700.0726223922347,\n \"radius_mi\": 2830.207847422583,\n \"include_crime_summary\": true,\n \"start\": \"string\",\n \"end\": \"string\",\n \"categories\": [\n \"string\",\n \"string\"\n ]\n },\n \"meta\": {\n \"count\": 9988,\n \"truncated\": true,\n \"next_cursor\": \"string\",\n \"compute_ms\": 7936\n },\n \"crime_instances\": [\n {\n \"lat\": 4397.682189166092,\n \"lon\": 9351.297734858405,\n \"id\": 3928,\n \"datetime\": \"string\",\n \"distance_mi\": 6359.920577304683,\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\": 2003.7298012353854,\n \"lon\": 5909.163272936959,\n \"id\": 7304,\n \"datetime\": \"string\",\n \"distance_mi\": 38.07643400570049,\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\": 6734\n },\n \"by_severity\": {\n \"key_0\": 7095,\n \"key_1\": 9065,\n \"key_2\": 3600\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\": 6744.967779004991,\n \"longitude\": 1344.6355419802746,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ce92e32-1001-4117-bf2f-21d2bc86d97b", "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": "f9fdfc0c-6ea5-49aa-af7b-fce86ba05944", "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": "6bc2c761-dbc2-4278-a61a-eadc6b53a2f3", "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": "5209e559-1be5-46be-a97a-1428b5d4e959", "name": "Fire Risk", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2542f677-1905-4800-9839-bff07af58ea8", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5b0e7f91-0b6b-49f6-ac2f-f2e39c62b379", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "ab8751fa-8678-4a37-8028-ee0cb64b189f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "a8835ffc-ead5-4867-9a05-57736bc87c0f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "83533734-b8f9-4346-a5ae-3e3ddeccee64", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "fire-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "e2cb9f50-4d02-4f5a-b24b-35177dc0de08", "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\": -1.8576943355695335,\n \"longitude\": 68.55738370600383,\n \"maps_api_response\": {\n \"key_0\": 9266.578154066434,\n \"key_1\": 2358.2033162811645\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "54c1b8b1-dace-4c2a-bc6f-abe09c3aab3d", "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\": -1.8576943355695335,\n \"longitude\": 68.55738370600383,\n \"maps_api_response\": {\n \"key_0\": 9266.578154066434,\n \"key_1\": 2358.2033162811645\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": "931f1143-25a4-4968-b1bf-77b83fb6c6e4", "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\": -1.8576943355695335,\n \"longitude\": 68.55738370600383,\n \"maps_api_response\": {\n \"key_0\": 9266.578154066434,\n \"key_1\": 2358.2033162811645\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": "0fde600b-3607-4c05-a70e-bb1f40cb54f0", "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\": -1.8576943355695335,\n \"longitude\": 68.55738370600383,\n \"maps_api_response\": {\n \"key_0\": 9266.578154066434,\n \"key_1\": 2358.2033162811645\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": "7cf1d36c-fb4a-4e39-ac10-a7ff29b17032", "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\": -1.8576943355695335,\n \"longitude\": 68.55738370600383,\n \"maps_api_response\": {\n \"key_0\": 9266.578154066434,\n \"key_1\": 2358.2033162811645\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": "e9968486-7ccc-4933-93cd-d475b5856e4a", "name": "Socioeconomic Data", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8b3a6e48-1e6e-4f07-b6c2-46c9f1f94499", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "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": "a738cbcc-847a-4b0c-a998-665055d9edcd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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\": 3850.305693464402,\n \"longitude\": 5670.192392172859,\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\": 5004.211115585282,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 4078.9217706572135,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 395.3654519121574,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 5450.844740087912,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 5996.093550927013,\n \"grade\": \"string\"\n }\n }\n }\n ],\n \"natural_hazards\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 5763.529429636889,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 3005.611208817891,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 674.7704858833048,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 4621.17461644338,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 8121.023224586801,\n \"grade\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ceb5ac-55b5-4a55-9436-a0f35fa9b31f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "8e1775bd-86eb-442d-8bed-f23f8206c698", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "fbaad0dd-fe13-4443-8417-43f0ffd01c66", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" }, { "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": "8a3191e6-3292-4b16-9b88-100116108ea5", "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": "c23df665-3dd9-4fc3-9d28-f945e6701c0c", "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\": 508.7289711233689,\n \"longitude\": 5616.545606291963,\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\": 346.71443641508756,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 51.08941103407982,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 7210.515002829156,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 2646.695152257712,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 5039.437781388418,\n \"grade\": \"string\"\n }\n }\n }\n ],\n \"natural_hazards\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 4536.67328452507,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 3849.4627753253008,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 3815.5741334384106,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 4136.280971082489,\n \"grade\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26dd515d-7a2d-4caa-baf5-65ab125c717f", "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": "a6db17ad-abb1-4e14-a259-89d716a33140", "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": "abdc4385-168b-459d-99cc-badc4d79ec82", "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": "83d39cb8-c78c-414b-a05b-9bb5cf695e22", "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": "county", "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": "a9b5f1a5-5ac1-4ab5-86e0-22360c4abb13", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "county" }, { "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\": 508.7289711233689,\n \"longitude\": 5616.545606291963,\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\": 346.71443641508756,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 51.08941103407982,\n \"grade\": \"string\"\n },\n \"key_1\": {\n \"value\": 7210.515002829156,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 2646.695152257712,\n \"grade\": \"string\",\n \"indices\": {\n \"key_0\": {\n \"value\": 5039.437781388418,\n \"grade\": \"string\"\n }\n }\n }\n ],\n \"natural_hazards\": [\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 4536.67328452507,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 3849.4627753253008,\n \"grade\": \"string\"\n }\n }\n },\n {\n \"geography_level\": \"string\",\n \"comparison_basis\": \"string\",\n \"total_index\": 3815.5741334384106,\n \"grade\": \"string\",\n \"hazards\": {\n \"key_0\": {\n \"value\": 4136.280971082489,\n \"grade\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "390eb182-9736-4534-a6f9-17bb94c098b0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "county" }, { "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": "2c6b321a-70a0-46e6-bea5-9e24c7ce7e4f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "county" }, { "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": "a3f8b23e-fca7-4298-8687-fc7c81202a54", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "socioeconomic-data", "by-geoid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geoid", "value": "string" }, { "key": "geography", "value": "county" }, { "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": "29d58f9b-6850-46c0-bdcc-97cbc930304e", "name": "Natural Hazards", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "383dc712-53af-4186-a173-a040dc2dd029", "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": "21.21669647441564", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "145.12985070065935", "description": "Longitude" }, { "disabled": false, "key": "year", "value": "2023", "description": "Data year" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a69c2c15-8eef-4546-8f0f-a6060e3211da", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "natural-hazards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "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\": 9324.81166829334,\n \"key_1\": 6847\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a625cb84-e175-4db7-a358-b3af6006fc52", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "natural-hazards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "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": "79fbc28e-2c56-4d6a-9f97-6d5cd5f05516", "name": "AVM - Automated Valuation Models", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "89594a3d-0607-4bde-bad8-493bedf9f834", "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": "5694008f-1b9c-47b9-a9e9-9da85bbdd9fd", "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": "c40e6d30-5425-4e36-a773-7ca4af69958b", "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": "1d0fe747-1264-466e-be7d-2d32c9c45993", "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": "d2f1b6d5-84f7-4559-8edd-26404fef0969", "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": "9c20780c-b7a1-4050-97b4-ce2541b58b88", "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": "21.21669647441564", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "145.12985070065935", "description": "Longitude" }, { "disabled": false, "key": "total_bedrooms", "value": "1", "description": "(Required) Total bedrooms" }, { "disabled": false, "key": "total_bathrooms", "value": "18.93453108853492", "description": "(Required) Total bathrooms" }, { "disabled": false, "key": "living_area", "value": "3845", "description": "Living area sqft" }, { "disabled": false, "key": "lot_size", "value": "1367", "description": "Lot size sqft" }, { "disabled": false, "key": "year_built", "value": "1863", "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": "67", "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": "1.8606650320695806", "description": "Condition score (1-5)" }, { "disabled": false, "key": "radius_mi", "value": "5", "description": "Search radius in miles" }, { "disabled": false, "key": "lookback_months", "value": "11", "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": "fde5232d-4b4b-46f3-b3e6-65748e9c9aae", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "1" }, { "key": "total_bathrooms", "value": "18.93453108853492" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "67" }, { "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": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "bc619bfb-b681-4510-bc39-4f4f511d2123", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "1" }, { "key": "total_bathrooms", "value": "18.93453108853492" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "67" }, { "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": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "4d00659e-47d0-4b4f-9b71-90102ceec25b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "1" }, { "key": "total_bathrooms", "value": "18.93453108853492" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "67" }, { "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": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "530260c1-59fa-42ad-aa2b-5de072a65993", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "property" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "1" }, { "key": "total_bathrooms", "value": "18.93453108853492" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "2" }, { "key": "walk_score", "value": "67" }, { "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": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "bfd1bece-480d-481c-a8df-6ddaca75d12e", "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": "ae8731d8-2e86-4490-a6ce-aa76f446cc37", "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\": 2141.322856174104,\n \"longitude\": 2861.6962454303184,\n \"geohash8\": \"string\",\n \"census_geoids\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n \"valuation\": {\n \"key_0\": 4507\n },\n \"comparables\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25191082-a9ab-43b7-b696-97196a20351c", "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": "156d300b-b5b0-46c3-973c-de44512d9a65", "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": "fd805da9-b1fc-4091-ab60-fc8f7ba361bc", "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": "e115f65e-811a-40d7-bcea-149aa9bdf044", "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": "21.21669647441564", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "145.12985070065935", "description": "Longitude" }, { "disabled": false, "key": "bedrooms", "value": "3", "description": "(Required) Bedrooms in unit" }, { "disabled": false, "key": "bathrooms", "value": "3.6472274162832408", "description": "(Required) Bathrooms in unit" }, { "disabled": false, "key": "size", "value": "4479", "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": "4807", "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": "67", "description": "Walk score" }, { "disabled": false, "key": "condition", "value": "1.8606650320695806", "description": "Condition score (1-5)" }, { "disabled": false, "key": "has_central_air", "value": "true", "description": "Has central air" }, { "disabled": false, "key": "in_unit_laundry", "value": "false", "description": "Has in-unit laundry" }, { "disabled": false, "key": "off_street_parking", "value": "false", "description": "Has off-street parking" }, { "disabled": false, "key": "radius_mi", "value": "5", "description": "Search radius in miles" }, { "disabled": false, "key": "lookback_months", "value": "11", "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": "a4cdfd52-4e42-4175-a118-758cfb929123", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "3.6472274162832408" }, { "key": "size", "value": "4479" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "4807" }, { "key": "walk_score", "value": "67" }, { "key": "condition", "value": "1.8606650320695806" }, { "key": "has_central_air", "value": "true" }, { "key": "in_unit_laundry", "value": "false" }, { "key": "off_street_parking", "value": "false" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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\": 2141.322856174104,\n \"longitude\": 2861.6962454303184,\n \"geohash8\": \"string\",\n \"census_geoids\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n \"valuation\": {\n \"key_0\": 4507\n },\n \"comparables\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd33b472-268e-435f-ae58-9a783160233c", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "3.6472274162832408" }, { "key": "size", "value": "4479" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "4807" }, { "key": "walk_score", "value": "67" }, { "key": "condition", "value": "1.8606650320695806" }, { "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": "11" }, { "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": "579fd209-a2f8-495b-b319-9c1bced56ffb", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "3.6472274162832408" }, { "key": "size", "value": "4479" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "4807" }, { "key": "walk_score", "value": "67" }, { "key": "condition", "value": "1.8606650320695806" }, { "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": "11" }, { "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": "82c40c28-197d-4bb0-abae-13e80d7df924", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "rental" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "bedrooms", "value": "3" }, { "key": "bathrooms", "value": "3.6472274162832408" }, { "key": "size", "value": "4479" }, { "key": "fully_furnished", "value": "false" }, { "key": "property_type", "value": "string" }, { "key": "total_units", "value": "4807" }, { "key": "walk_score", "value": "67" }, { "key": "condition", "value": "1.8606650320695806" }, { "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": "11" }, { "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": "9502eb36-bd7b-4521-a949-64ac07ef8202", "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\": 690,\n \"bathrooms\": 3443.2806510126325,\n \"total_units\": 533,\n \"living_area\": 3705,\n \"lot_size\": 8471,\n \"year_built\": 2014,\n \"property_type\": \"string\",\n \"num_stories\": 1953.2632434598772,\n \"condition_rating\": 2.7188488392621615\n },\n \"search_params\": {\n \"radius_mi\": 5,\n \"lookback_months\": 12,\n \"num_comps\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "510a94e6-f199-4242-b389-cd25633e298d", "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\": 690,\n \"bathrooms\": 3443.2806510126325,\n \"total_units\": 533,\n \"living_area\": 3705,\n \"lot_size\": 8471,\n \"year_built\": 2014,\n \"property_type\": \"string\",\n \"num_stories\": 1953.2632434598772,\n \"condition_rating\": 2.7188488392621615\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": "0aa26555-b551-4586-ae3e-a2f65a91b6fe", "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\": 690,\n \"bathrooms\": 3443.2806510126325,\n \"total_units\": 533,\n \"living_area\": 3705,\n \"lot_size\": 8471,\n \"year_built\": 2014,\n \"property_type\": \"string\",\n \"num_stories\": 1953.2632434598772,\n \"condition_rating\": 2.7188488392621615\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": "4c29557d-0727-4c4b-bcc9-6bac28f4ed61", "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\": 690,\n \"bathrooms\": 3443.2806510126325,\n \"total_units\": 533,\n \"living_area\": 3705,\n \"lot_size\": 8471,\n \"year_built\": 2014,\n \"property_type\": \"string\",\n \"num_stories\": 1953.2632434598772,\n \"condition_rating\": 2.7188488392621615\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": "e5042650-5a1f-4c29-b99d-666d4521d256", "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\": 690,\n \"bathrooms\": 3443.2806510126325,\n \"total_units\": 533,\n \"living_area\": 3705,\n \"lot_size\": 8471,\n \"year_built\": 2014,\n \"property_type\": \"string\",\n \"num_stories\": 1953.2632434598772,\n \"condition_rating\": 2.7188488392621615\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": "80064e64-d0d9-492b-a8f8-1cc0053c6f91", "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": "21.21669647441564", "description": "Latitude" }, { "disabled": false, "key": "longitude", "value": "145.12985070065935", "description": "Longitude" }, { "disabled": false, "key": "total_bedrooms", "value": "74", "description": "(Required) Total bedrooms" }, { "disabled": false, "key": "total_bathrooms", "value": "55.56296699135319", "description": "(Required) Total bathrooms" }, { "disabled": false, "key": "total_units", "value": "128", "description": "(Required) Total units (must be 2-1000)" }, { "disabled": false, "key": "living_area", "value": "3845", "description": "Living area sqft" }, { "disabled": false, "key": "lot_size", "value": "1367", "description": "Lot size sqft" }, { "disabled": false, "key": "year_built", "value": "1863", "description": "Year built" }, { "disabled": false, "key": "walk_score", "value": "67", "description": "Walk score" }, { "disabled": false, "key": "num_stories", "value": "4487.537560346895", "description": "Number of stories" }, { "disabled": false, "key": "condition_rating", "value": "1.8606650320695806", "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": "11", "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": "51085aba-6190-42fb-aea1-22a814060e53", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "74" }, { "key": "total_bathrooms", "value": "55.56296699135319" }, { "key": "total_units", "value": "128" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "walk_score", "value": "67" }, { "key": "num_stories", "value": "4487.537560346895" }, { "key": "condition_rating", "value": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "a30d4b8d-7550-4fbb-bad9-dcc026d4c483", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "74" }, { "key": "total_bathrooms", "value": "55.56296699135319" }, { "key": "total_units", "value": "128" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "walk_score", "value": "67" }, { "key": "num_stories", "value": "4487.537560346895" }, { "key": "condition_rating", "value": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "139b8a9c-65b1-4e19-a3b4-25b108833b3b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "74" }, { "key": "total_bathrooms", "value": "55.56296699135319" }, { "key": "total_units", "value": "128" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "walk_score", "value": "67" }, { "key": "num_stories", "value": "4487.537560346895" }, { "key": "condition_rating", "value": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "ddbb46d8-22f4-45d5-813c-ef4c665b4ce1", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "avm", "multifamily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "string" }, { "key": "latitude", "value": "21.21669647441564" }, { "key": "longitude", "value": "145.12985070065935" }, { "key": "total_bedrooms", "value": "74" }, { "key": "total_bathrooms", "value": "55.56296699135319" }, { "key": "total_units", "value": "128" }, { "key": "living_area", "value": "3845" }, { "key": "lot_size", "value": "1367" }, { "key": "year_built", "value": "1863" }, { "key": "walk_score", "value": "67" }, { "key": "num_stories", "value": "4487.537560346895" }, { "key": "condition_rating", "value": "1.8606650320695806" }, { "key": "radius_mi", "value": "5" }, { "key": "lookback_months", "value": "11" }, { "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": "82fd3348-7d26-4d49-a9f7-9ebc658646ae", "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": "60766483-70e1-41fc-8f27-f52cca796569", "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\": \"complete\",\n \"avm_type\": \"string\",\n \"total\": 7545,\n \"status_url\": \"string\",\n \"created_at\": \"string\",\n \"notify_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "354955dd-770f-4d70-99ad-89538e6f626f", "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": "5a3c96e5-619f-47be-988e-33772780fca2", "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": "21761162-a79e-440f-b890-9d8099f6f4ec", "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": "359b7ebc-32d1-46d8-bb5f-d1698e45e0da", "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\": 1,\n \"bathrooms\": 6.156787454553408,\n \"size\": 2900,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 6904,\n \"condition\": 3.0003918087824113,\n \"has_central_air\": false,\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": "64fffbf6-077a-4c1c-ac78-b325b414a262", "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\": 1,\n \"bathrooms\": 6.156787454553408,\n \"size\": 2900,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 6904,\n \"condition\": 3.0003918087824113,\n \"has_central_air\": false,\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\": \"complete\",\n \"avm_type\": \"string\",\n \"total\": 7545,\n \"status_url\": \"string\",\n \"created_at\": \"string\",\n \"notify_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eae68c7c-9f3d-4d99-9f2c-001fd9ef39a9", "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\": 1,\n \"bathrooms\": 6.156787454553408,\n \"size\": 2900,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 6904,\n \"condition\": 3.0003918087824113,\n \"has_central_air\": false,\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": "1c1615a8-03e7-4af2-b54f-91780bc1bf15", "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\": 1,\n \"bathrooms\": 6.156787454553408,\n \"size\": 2900,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 6904,\n \"condition\": 3.0003918087824113,\n \"has_central_air\": false,\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": "763a704d-33e9-491b-b5bd-19ae702a9b40", "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\": 1,\n \"bathrooms\": 6.156787454553408,\n \"size\": 2900,\n \"is_furnished\": false\n }\n ],\n \"property_type\": \"string\",\n \"total_units\": 6904,\n \"condition\": 3.0003918087824113,\n \"has_central_air\": false,\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": "c3dc1bb0-550b-4174-9ff2-5ac469ffef4e", "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\": 392,\n \"bathrooms\": 2946.605068314984,\n \"total_units\": 261,\n \"living_area\": 4620,\n \"lot_size\": 6734,\n \"year_built\": 1986,\n \"property_type\": \"string\",\n \"num_stories\": 2467.913235998994,\n \"condition_rating\": 2.360466263155109\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": "3a19e788-a888-42db-9d97-683151da9b04", "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\": 392,\n \"bathrooms\": 2946.605068314984,\n \"total_units\": 261,\n \"living_area\": 4620,\n \"lot_size\": 6734,\n \"year_built\": 1986,\n \"property_type\": \"string\",\n \"num_stories\": 2467.913235998994,\n \"condition_rating\": 2.360466263155109\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\": \"complete\",\n \"avm_type\": \"string\",\n \"total\": 7545,\n \"status_url\": \"string\",\n \"created_at\": \"string\",\n \"notify_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c237572-6952-4574-be99-c592c077f899", "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\": 392,\n \"bathrooms\": 2946.605068314984,\n \"total_units\": 261,\n \"living_area\": 4620,\n \"lot_size\": 6734,\n \"year_built\": 1986,\n \"property_type\": \"string\",\n \"num_stories\": 2467.913235998994,\n \"condition_rating\": 2.360466263155109\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": "1f660cea-8be0-4254-b732-369e0805fd2c", "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\": 392,\n \"bathrooms\": 2946.605068314984,\n \"total_units\": 261,\n \"living_area\": 4620,\n \"lot_size\": 6734,\n \"year_built\": 1986,\n \"property_type\": \"string\",\n \"num_stories\": 2467.913235998994,\n \"condition_rating\": 2.360466263155109\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": "d544b38a-565a-4a7f-8b83-088b279eb33b", "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\": 392,\n \"bathrooms\": 2946.605068314984,\n \"total_units\": 261,\n \"living_area\": 4620,\n \"lot_size\": 6734,\n \"year_built\": 1986,\n \"property_type\": \"string\",\n \"num_stories\": 2467.913235998994,\n \"condition_rating\": 2.360466263155109\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": "938e90fe-2002-416d-85f3-e40967c3e710", "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": "2ec2047d-c653-445d-abdd-e3d5ac15dcc8", "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\": 4575,\n \"completed\": 6758,\n \"failed\": 1985,\n \"progress_pct\": 5094.9002813734405,\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"completed_at\": \"string\",\n \"notify_url\": \"string\",\n \"webhook_delivered\": false,\n \"results\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n {\n \"key_0\": 5412,\n \"key_1\": 2942,\n \"key_2\": 5557\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86978607-df86-4114-966a-172796f895e8", "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": "c17a8432-ad5c-4a5d-804a-68ba8fc06db5", "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": "59867c33-4de3-4dee-a764-a31777b93086", "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": "009c7fcc-c698-404d-9bfd-7c2d1825b247", "name": "Sinkhole Risk", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3b0a1a84-c9b4-4143-8ff7-ad7ca3349a7e", "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": "3.350248499548229", "description": "Latitude coordinate" }, { "disabled": false, "key": "longitude", "value": "70.90620486576836", "description": "Longitude coordinate" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a4944f84-4d0b-4e31-93b5-ff74afea77e0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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\": 3117.53839189032,\n \"risk_level\": 0,\n \"risk_label\": \"moderate\",\n \"resolution_m\": 608,\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\": 9839.61383977048,\n \"longitude\": 8491.968550991209,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e32b8852-17a6-44b9-bfe0-3a367306f862", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "a91d8cbe-f213-485c-8b26-66a1dd93571b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "sinkhole-risk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "address", "value": "123 Main St, Orlando, FL 32801" }, { "key": "latitude", "value": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "be82f157-4683-48d5-b962-2be95155341c", "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": "3.350248499548229" }, { "key": "longitude", "value": "70.90620486576836" } ], "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": "270c6d0e-8c73-4dc8-802f-0eacd7b83b10", "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\": -78.61667682336096,\n \"longitude\": 21.36258357002052,\n \"maps_api_response\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a266e30-5412-498e-a5a9-e85179df44e6", "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\": -78.61667682336096,\n \"longitude\": 21.36258357002052,\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\": 3117.53839189032,\n \"risk_level\": 0,\n \"risk_label\": \"moderate\",\n \"resolution_m\": 608,\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\": 9839.61383977048,\n \"longitude\": 8491.968550991209,\n \"geohash8\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b474bff-b5b6-4fe3-8474-9c722ab039a9", "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\": -78.61667682336096,\n \"longitude\": 21.36258357002052,\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": "c29ca2de-d082-48b7-aae8-21105b56b395", "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\": -78.61667682336096,\n \"longitude\": 21.36258357002052,\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": "5a3f3ce6-d36d-4a7b-ab1d-6974bbe4cfd6", "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\": -78.61667682336096,\n \"longitude\": 21.36258357002052,\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": "ea73dc7a-04ae-478e-b457-93063b54dd93", "name": "Comprehensive", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7870a946-c649-46a0-bbc8-9e3d925bb9d8", "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 \"census-data\"\n ],\n \"address\": \"string\",\n \"latitude\": 72.45010432764207,\n \"longitude\": 22.252662510262695,\n \"beds\": 25,\n \"baths\": 33.60812984357923,\n \"living_area\": 7027,\n \"lot_size\": 3355,\n \"year_built\": 1894,\n \"property_type\": \"string\",\n \"total_units\": 94,\n \"condition\": 1076.5323255369608,\n \"porch\": false,\n \"deck\": true,\n \"pool\": true,\n \"basement\": false,\n \"adu\": true,\n \"patio\": true,\n \"balcony\": false,\n \"central_air\": false,\n \"in_unit_laundry\": true,\n \"fireplace_count\": 0,\n \"garage_spaces\": 0,\n \"other_spaces\": 3,\n \"num_stories\": 4210,\n \"walk_score\": 76,\n \"month_sold\": 5,\n \"year_sold\": 1980,\n \"units\": [\n {\n \"beds\": 2,\n \"baths\": 0.07514981261261822,\n \"living_area\": 575,\n \"furnished\": false\n },\n {\n \"beds\": 3,\n \"baths\": 0.07626578316913157,\n \"living_area\": 3086,\n \"furnished\": false\n }\n ],\n \"furnished\": true,\n \"laundry\": true,\n \"parking\": false,\n \"mixed_use\": true,\n \"date\": \"string\",\n \"lookback_months\": 22,\n \"radius_mi\": 8.436181909815485,\n \"num_comparables\": 31,\n \"include_grades\": true,\n \"year\": 2020,\n \"geographies\": [\n \"string\",\n \"string\"\n ],\n \"census_keys\": [\n \"string\",\n \"string\"\n ],\n \"years\": [\n 4111,\n 5180\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\": 132\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31380302-461c-4e9a-a097-adf044597665", "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 \"multifamily-avm\"\n ],\n \"address\": \"string\",\n \"latitude\": 18.75129068218918,\n \"longitude\": -61.491903524734425,\n \"beds\": 37,\n \"baths\": 30.323155274975257,\n \"living_area\": 5107,\n \"lot_size\": 8600,\n \"year_built\": 1958,\n \"property_type\": \"string\",\n \"total_units\": 216,\n \"condition\": 3049.0132667446155,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": false,\n \"adu\": true,\n \"patio\": false,\n \"balcony\": false,\n \"central_air\": true,\n \"in_unit_laundry\": false,\n \"fireplace_count\": 5,\n \"garage_spaces\": 8,\n \"other_spaces\": 0,\n \"num_stories\": 2110,\n \"walk_score\": 41,\n \"month_sold\": 3,\n \"year_sold\": 1909,\n \"units\": [\n {\n \"beds\": 2,\n \"baths\": 2.111040726670128,\n \"living_area\": 9666,\n \"furnished\": false\n },\n {\n \"beds\": 3,\n \"baths\": 1.8907210940086472,\n \"living_area\": 1654,\n \"furnished\": false\n }\n ],\n \"furnished\": true,\n \"laundry\": false,\n \"parking\": false,\n \"mixed_use\": false,\n \"date\": \"string\",\n \"lookback_months\": 23,\n \"radius_mi\": 15.338823607050081,\n \"num_comparables\": 7,\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 5155,\n 8323\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": false,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 137\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address_info\": {\n \"key_0\": true\n },\n \"property_avm\": {\n \"key_0\": true,\n \"key_1\": false\n },\n \"rental_avm\": {\n \"key_0\": 4822,\n \"key_1\": false\n },\n \"multifamily_avm\": {\n \"key_0\": \"string\"\n },\n \"census_data\": {\n \"key_0\": true,\n \"key_1\": 5339\n },\n \"location_data\": {\n \"key_0\": false\n },\n \"metadata\": {\n \"api_version\": \"v1.0.0\",\n \"compute_ms\": 2471,\n \"request_id\": \"string\",\n \"response_timestamp\": \"string\",\n \"credits_used\": 5674,\n \"credits_breakdown\": {\n \"key_0\": 31,\n \"key_1\": 3166\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c86dddd-020b-4496-8c57-94b107c44b68", "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 \"multifamily-avm\"\n ],\n \"address\": \"string\",\n \"latitude\": 18.75129068218918,\n \"longitude\": -61.491903524734425,\n \"beds\": 37,\n \"baths\": 30.323155274975257,\n \"living_area\": 5107,\n \"lot_size\": 8600,\n \"year_built\": 1958,\n \"property_type\": \"string\",\n \"total_units\": 216,\n \"condition\": 3049.0132667446155,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": false,\n \"adu\": true,\n \"patio\": false,\n \"balcony\": false,\n \"central_air\": true,\n \"in_unit_laundry\": false,\n \"fireplace_count\": 5,\n \"garage_spaces\": 8,\n \"other_spaces\": 0,\n \"num_stories\": 2110,\n \"walk_score\": 41,\n \"month_sold\": 3,\n \"year_sold\": 1909,\n \"units\": [\n {\n \"beds\": 2,\n \"baths\": 2.111040726670128,\n \"living_area\": 9666,\n \"furnished\": false\n },\n {\n \"beds\": 3,\n \"baths\": 1.8907210940086472,\n \"living_area\": 1654,\n \"furnished\": false\n }\n ],\n \"furnished\": true,\n \"laundry\": false,\n \"parking\": false,\n \"mixed_use\": false,\n \"date\": \"string\",\n \"lookback_months\": 23,\n \"radius_mi\": 15.338823607050081,\n \"num_comparables\": 7,\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 5155,\n 8323\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": false,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 137\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38a6d93f-e73e-49fa-8716-0d8eadc5bd28", "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 \"multifamily-avm\"\n ],\n \"address\": \"string\",\n \"latitude\": 18.75129068218918,\n \"longitude\": -61.491903524734425,\n \"beds\": 37,\n \"baths\": 30.323155274975257,\n \"living_area\": 5107,\n \"lot_size\": 8600,\n \"year_built\": 1958,\n \"property_type\": \"string\",\n \"total_units\": 216,\n \"condition\": 3049.0132667446155,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": false,\n \"adu\": true,\n \"patio\": false,\n \"balcony\": false,\n \"central_air\": true,\n \"in_unit_laundry\": false,\n \"fireplace_count\": 5,\n \"garage_spaces\": 8,\n \"other_spaces\": 0,\n \"num_stories\": 2110,\n \"walk_score\": 41,\n \"month_sold\": 3,\n \"year_sold\": 1909,\n \"units\": [\n {\n \"beds\": 2,\n \"baths\": 2.111040726670128,\n \"living_area\": 9666,\n \"furnished\": false\n },\n {\n \"beds\": 3,\n \"baths\": 1.8907210940086472,\n \"living_area\": 1654,\n \"furnished\": false\n }\n ],\n \"furnished\": true,\n \"laundry\": false,\n \"parking\": false,\n \"mixed_use\": false,\n \"date\": \"string\",\n \"lookback_months\": 23,\n \"radius_mi\": 15.338823607050081,\n \"num_comparables\": 7,\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 5155,\n 8323\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": false,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 137\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": "8a7f9b4f-df5c-496e-9f3c-e5faed976078", "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 \"multifamily-avm\"\n ],\n \"address\": \"string\",\n \"latitude\": 18.75129068218918,\n \"longitude\": -61.491903524734425,\n \"beds\": 37,\n \"baths\": 30.323155274975257,\n \"living_area\": 5107,\n \"lot_size\": 8600,\n \"year_built\": 1958,\n \"property_type\": \"string\",\n \"total_units\": 216,\n \"condition\": 3049.0132667446155,\n \"porch\": true,\n \"deck\": true,\n \"pool\": false,\n \"basement\": false,\n \"adu\": true,\n \"patio\": false,\n \"balcony\": false,\n \"central_air\": true,\n \"in_unit_laundry\": false,\n \"fireplace_count\": 5,\n \"garage_spaces\": 8,\n \"other_spaces\": 0,\n \"num_stories\": 2110,\n \"walk_score\": 41,\n \"month_sold\": 3,\n \"year_sold\": 1909,\n \"units\": [\n {\n \"beds\": 2,\n \"baths\": 2.111040726670128,\n \"living_area\": 9666,\n \"furnished\": false\n },\n {\n \"beds\": 3,\n \"baths\": 1.8907210940086472,\n \"living_area\": 1654,\n \"furnished\": false\n }\n ],\n \"furnished\": true,\n \"laundry\": false,\n \"parking\": false,\n \"mixed_use\": false,\n \"date\": \"string\",\n \"lookback_months\": 23,\n \"radius_mi\": 15.338823607050081,\n \"num_comparables\": 7,\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 5155,\n 8323\n ],\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"include_crime_summary\": false,\n \"include_crime_details\": true,\n \"offense_categories\": [\n \"string\",\n \"string\"\n ],\n \"limit\": 137\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": "c746fbee-767d-4125-940f-73fb6abd0bd4", "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" } } }