{ "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "parcels", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "d741bff6-e2a2-4658-a07d-34f16befbe0a", "name": "Get parcel by ID", "request": { "name": "Get parcel by ID", "description": { "content": "Retrieve a single parcel by its composite ID (county_fips:parcel_id).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Composite parcel identifier in the format county_fips:parcel_id (e.g., 37183:0012345).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "40a5c7a3-215c-4295-87a6-91cd3d46af75", "name": "Parcel found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier in the format county_fips:parcel_id (e.g., 37183:0012345).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"individual\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"mixed\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4337ee00-9020-4fa7-80b7-3f63ddf8f644", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier in the format county_fips:parcel_id (e.g., 37183:0012345).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "221a9920-9e38-4069-855f-40f2d4bfc2ed", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier in the format county_fips:parcel_id (e.g., 37183:0012345).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e48249-9261-4cb8-adde-dae05947efc5", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier in the format county_fips:parcel_id (e.g., 37183:0012345).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "owner", "description": "", "item": [ { "id": "04d5aeb2-037d-47f0-8107-ae6f484e84e6", "name": "Get parcel owner details and portfolio", "request": { "name": "Get parcel owner details and portfolio", "description": { "content": "Retrieve the owner of a parcel along with their portfolio summary and list of properties.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5f0bca21-d33d-419a-9943-08bee2bc07ae", "name": "Owner details returned.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"owner_name\": \"\",\n \"entity_type\": \"other\",\n \"mailing_address\": \"\",\n \"portfolio_summary\": {\n \"property_count\": \"\",\n \"total_assessed_value\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n },\n \"properties\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"individual\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"agricultural\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"trust\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"residential\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e72349fb-16de-4b78-95c7-de3e2e994872", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7017e36a-89c5-4e6c-8da2-1dc3cbea6bf7", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14f7e474-1bc6-4041-b645-8f30650169cb", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "permits", "description": "", "item": [ { "id": "c5e39ab7-2c73-4841-8963-d029b3e3d609", "name": "Get parcel permits", "request": { "name": "Get parcel permits", "description": { "content": "Retrieve building and construction permits associated with a parcel.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id", "permits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5a1d4e91-6b6e-46f0-b275-56a8d66b56d9", "name": "Permits returned.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "permits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"permit_number\": \"\",\n \"type\": \"\",\n \"status\": \"pending\",\n \"description\": \"\",\n \"issued_date\": \"\",\n \"estimated_cost\": \"\",\n \"contractor\": \"\"\n },\n {\n \"permit_number\": \"\",\n \"type\": \"\",\n \"status\": \"denied\",\n \"description\": \"\",\n \"issued_date\": \"\",\n \"estimated_cost\": \"\",\n \"contractor\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a507d40e-092e-4f33-8e05-d997e26b1b0d", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "permits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee93edb0-54f4-4607-ae10-1c1cbcc3ebde", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "permits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "247114a8-92ee-4a6d-8e8e-cf2e21dc6047", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "permits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "deeds", "description": "", "item": [ { "id": "3ab04076-c147-49f9-a998-3664510fd72b", "name": "Get parcel deed history", "request": { "name": "Get parcel deed history", "description": { "content": "Retrieve deed transactions and transfer history for a parcel.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id", "deeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "528aeb59-dd64-49f2-a25a-5814d0cff86f", "name": "Deeds returned.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "deeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"document_number\": \"\",\n \"recording_date\": \"\",\n \"sale_date\": \"\",\n \"sale_price\": \"\",\n \"grantor_name\": \"\",\n \"grantee_name\": \"\",\n \"deed_type\": \"\"\n },\n {\n \"document_number\": \"\",\n \"recording_date\": \"\",\n \"sale_date\": \"\",\n \"sale_price\": \"\",\n \"grantor_name\": \"\",\n \"grantee_name\": \"\",\n \"deed_type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "715eb69d-decb-44a8-a3bc-78997f637de2", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "deeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5435ed25-b419-4290-968a-dcb8bd36e120", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "deeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "323d9575-654b-4496-adfd-0b4f7f5f8cad", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "deeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "risks", "description": "", "item": [ { "id": "2731cea8-3ed2-4e76-a515-1220b895de21", "name": "Get parcel risk assessment", "request": { "name": "Get parcel risk assessment", "description": { "content": "Retrieve flood, wildfire, air quality, and crime risk data for a parcel.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id", "risks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c9a8c30e-3df0-41a8-a9e4-3cf64311404d", "name": "Risk assessment returned.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "risks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"flood_zone\": {\n \"zone\": \"\",\n \"in_floodplain\": \"\",\n \"description\": \"\"\n },\n \"wildfire\": {\n \"risk_class\": \"low\",\n \"burn_probability\": \"\"\n },\n \"air_quality\": {\n \"median_aqi\": \"\",\n \"category\": \"unhealthy_sensitive\"\n },\n \"crime\": {\n \"score\": \"\",\n \"tier\": \"low\",\n \"trend\": \"decreasing\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87e1cdbe-ddc0-427b-ae48-e4c3cef223f3", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "risks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce72caf-e49a-48a3-91e9-24ce617849e8", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "risks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bdfcf74-591a-46ee-ac99-69eaa0d6e1af", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "risks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite parcel identifier (county_fips:parcel_id).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "report", "description": "", "item": [ { "id": "f8e6a0e8-5a9a-4273-8ed7-79a07c3c778f", "name": "Comprehensive parcel report", "request": { "name": "Comprehensive parcel report", "description": { "content": "Returns the full canonical parcel record plus every enrichment: UCC liens, comparable sales, owner portfolio context, permits, deeds, hazard composite. This is the single most data-dense endpoint per parcel — designed for due-diligence and underwriting workflows. Heavier than parcels/{id}; cache aggressively when serving UIs.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS. Strongly recommended when passing a county-local id.", "type": "text/plain" }, "key": "county_fips", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Parcel ID. Composite `county_fips:parcel_id` or county-local id when `county_fips` query param is provided.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fd79f88c-de9f-4196-b7b1-9f52f0723272", "name": "Comprehensive report.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS. Strongly recommended when passing a county-local id.", "type": "text/plain" }, "key": "county_fips", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID. Composite `county_fips:parcel_id` or county-local id when `county_fips` query param is provided.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"parcel\": {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"corporation\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"mixed\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n \"ucc_liens\": [\n {\n \"filing_id\": \"\",\n \"debtor_name\": \"\",\n \"secured_party\": \"\",\n \"filing_date\": \"\",\n \"lapse_date\": \"\",\n \"filing_status\": \"\",\n \"match_method\": \"\",\n \"match_confidence\": \"\"\n },\n {\n \"filing_id\": \"\",\n \"debtor_name\": \"\",\n \"secured_party\": \"\",\n \"filing_date\": \"\",\n \"lapse_date\": \"\",\n \"filing_status\": \"\",\n \"match_method\": \"\",\n \"match_confidence\": \"\"\n }\n ],\n \"comparable_sales\": [\n {\n \"comp_parcel_id\": \"\",\n \"comp_sale_price\": \"\",\n \"comp_sale_date\": \"\",\n \"comp_sqft\": \"\",\n \"comp_beds\": \"\",\n \"comp_baths\": \"\",\n \"similarity_score\": \"\",\n \"distance_miles\": \"\"\n },\n {\n \"comp_parcel_id\": \"\",\n \"comp_sale_price\": \"\",\n \"comp_sale_date\": \"\",\n \"comp_sqft\": \"\",\n \"comp_beds\": \"\",\n \"comp_baths\": \"\",\n \"similarity_score\": \"\",\n \"distance_miles\": \"\"\n }\n ],\n \"permits\": [\n {\n \"permit_number\": \"\",\n \"type\": \"\",\n \"status\": \"pending\",\n \"description\": \"\",\n \"issued_date\": \"\",\n \"estimated_cost\": \"\",\n \"contractor\": \"\"\n },\n {\n \"permit_number\": \"\",\n \"type\": \"\",\n \"status\": \"expired\",\n \"description\": \"\",\n \"issued_date\": \"\",\n \"estimated_cost\": \"\",\n \"contractor\": \"\"\n }\n ],\n \"deeds\": [\n {\n \"document_number\": \"\",\n \"recording_date\": \"\",\n \"sale_date\": \"\",\n \"sale_price\": \"\",\n \"grantor_name\": \"\",\n \"grantee_name\": \"\",\n \"deed_type\": \"\"\n },\n {\n \"document_number\": \"\",\n \"recording_date\": \"\",\n \"sale_date\": \"\",\n \"sale_price\": \"\",\n \"grantor_name\": \"\",\n \"grantee_name\": \"\",\n \"deed_type\": \"\"\n }\n ],\n \"risk\": {\n \"flood_zone\": {\n \"zone\": \"\",\n \"in_floodplain\": \"\",\n \"description\": \"\"\n },\n \"wildfire\": {\n \"risk_class\": \"very_high\",\n \"burn_probability\": \"\"\n },\n \"air_quality\": {\n \"median_aqi\": \"\",\n \"category\": \"very_unhealthy\"\n },\n \"crime\": {\n \"score\": \"\",\n \"tier\": \"very_high\",\n \"trend\": \"increasing\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba5b5949-f14a-4fca-959a-6ffb0022d4c0", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS. Strongly recommended when passing a county-local id.", "type": "text/plain" }, "key": "county_fips", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID. Composite `county_fips:parcel_id` or county-local id when `county_fips` query param is provided.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de3839f-4466-4a58-8a04-0f1bd5b8594a", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS. Strongly recommended when passing a county-local id.", "type": "text/plain" }, "key": "county_fips", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID. Composite `county_fips:parcel_id` or county-local id when `county_fips` query param is provided.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2196904c-7ed7-4163-b8f8-72fd95645598", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS. Strongly recommended when passing a county-local id.", "type": "text/plain" }, "key": "county_fips", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID. Composite `county_fips:parcel_id` or county-local id when `county_fips` query param is provided.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "traffic-history", "description": "", "item": [ { "id": "dd3c2f89-c6be-4724-8d79-c8308e72e67c", "name": "Nearest traffic station + AADT history", "request": { "name": "Nearest traffic station + AADT history", "description": { "content": "Finds the AADT (annual average daily traffic) station nearest to the given coordinates and returns its historical time series plus 3/5/7-year CAGRs. Useful for retail / CRE site selection. Search radius ~2 miles; returns empty data if no station is in range.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", ":id", "traffic-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Latitude.", "type": "text/plain" }, "key": "lat", "value": "" }, { "disabled": false, "description": { "content": "(Required) Longitude.", "type": "text/plain" }, "key": "lng", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Parcel ID (used for context only; the actual nearest-station search is by lat/lng).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ea8ac2b9-c984-4663-bdf6-76b758e6675a", "name": "Nearest station data + historical AADT.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "traffic-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Latitude.", "type": "text/plain" }, "key": "lat", "value": "" }, { "disabled": false, "description": { "content": "(Required) Longitude.", "type": "text/plain" }, "key": "lng", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID (used for context only; the actual nearest-station search is by lat/lng).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"station\": null,\n \"history\": [\n {\n \"year\": \"\",\n \"aadt\": \"\"\n },\n {\n \"year\": \"\",\n \"aadt\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c97e3ac4-a88b-47fc-b45f-826a930b2e92", "name": "lat / lng required.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "traffic-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Latitude.", "type": "text/plain" }, "key": "lat", "value": "" }, { "disabled": false, "description": { "content": "(Required) Longitude.", "type": "text/plain" }, "key": "lng", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID (used for context only; the actual nearest-station search is by lat/lng).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4093b8eb-9dc9-44cb-b51d-b25779b125e6", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "traffic-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Latitude.", "type": "text/plain" }, "key": "lat", "value": "" }, { "disabled": false, "description": { "content": "(Required) Longitude.", "type": "text/plain" }, "key": "lng", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID (used for context only; the actual nearest-station search is by lat/lng).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e3fc0c8-4aa7-42c8-9b42-94eee2d48c9b", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "traffic-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Latitude.", "type": "text/plain" }, "key": "lat", "value": "" }, { "disabled": false, "description": { "content": "(Required) Longitude.", "type": "text/plain" }, "key": "lng", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID (used for context only; the actual nearest-station search is by lat/lng).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "623108b3-202e-48a3-9271-55289e6c8cec", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", ":id", "traffic-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Latitude.", "type": "text/plain" }, "key": "lat", "value": "" }, { "disabled": false, "description": { "content": "(Required) Longitude.", "type": "text/plain" }, "key": "lng", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parcel ID (used for context only; the actual nearest-station search is by lat/lng).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "geojson", "description": "", "item": [ { "id": "658992aa-9975-4fb5-b632-c781c0dd6ad7", "name": "Parcel polygons as GeoJSON for a bounding box", "request": { "name": "Parcel polygons as GeoJSON for a bounding box", "description": { "content": "Returns parcel polygons inside a bounding box as a GeoJSON FeatureCollection. Only served at zoom ≥ 14 to limit data volume — coarser bbox returns an empty collection. Each feature's properties include parcel_id, county_fips, owner_name, assessed value, and basic attributes for rendering popups.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "parcels", "geojson" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Bounding box `west,south,east,north`.", "type": "text/plain" }, "key": "bbox", "value": "-963,-90258447.6,8.75024936,1340469" }, { "disabled": false, "description": { "content": "(Required) Map zoom level. Below 14 returns an empty collection.", "type": "text/plain" }, "key": "zoom", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e176e4c-de0a-47b8-8a6d-84233ee77330", "name": "GeoJSON FeatureCollection. Empty `features` array if zoom < 14 or bbox is too wide (>0.15° span).", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", "geojson" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Bounding box `west,south,east,north`.", "type": "text/plain" }, "key": "bbox", "value": "-963,-90258447.6,8.75024936,1340469" }, { "disabled": false, "description": { "content": "(Required) Map zoom level. Below 14 returns an empty collection.", "type": "text/plain" }, "key": "zoom", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"type\": \"\",\n \"features\": [\n {\n \"type\": \"\",\n \"geometry\": {\n \"type\": \"\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n },\n \"properties\": {\n \"parcel_id\": \"\",\n \"county_fips\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"owner_name\": \"\",\n \"total_assessed_value\": \"\",\n \"property_type\": \"\",\n \"year_built\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"geometry\": {\n \"type\": \"\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n },\n \"properties\": {\n \"parcel_id\": \"\",\n \"county_fips\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"owner_name\": \"\",\n \"total_assessed_value\": \"\",\n \"property_type\": \"\",\n \"year_built\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ecb46fa-fee7-4d92-8716-8f5ae421b436", "name": "Invalid bbox.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", "geojson" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Bounding box `west,south,east,north`.", "type": "text/plain" }, "key": "bbox", "value": "-963,-90258447.6,8.75024936,1340469" }, { "disabled": false, "description": { "content": "(Required) Map zoom level. Below 14 returns an empty collection.", "type": "text/plain" }, "key": "zoom", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb5469e-01a9-4d5a-8613-b12fd578d602", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", "geojson" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Bounding box `west,south,east,north`.", "type": "text/plain" }, "key": "bbox", "value": "-963,-90258447.6,8.75024936,1340469" }, { "disabled": false, "description": { "content": "(Required) Map zoom level. Below 14 returns an empty collection.", "type": "text/plain" }, "key": "zoom", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc49fb9-ad3d-4e23-86a5-5d87b8a52dfa", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "parcels", "geojson" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Bounding box `west,south,east,north`.", "type": "text/plain" }, "key": "bbox", "value": "-963,-90258447.6,8.75024936,1340469" }, { "disabled": false, "description": { "content": "(Required) Map zoom level. Below 14 returns an empty collection.", "type": "text/plain" }, "key": "zoom", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "search", "description": "", "item": [ { "id": "e3dfa42a-b33b-4f8c-9c49-7649f23cf8f2", "name": "Search parcels", "request": { "name": "Search parcels", "description": { "content": "Search parcels within geographic bounds with optional filters, sorting, and pagination.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bounds\": {\n \"north\": \"\",\n \"south\": \"\",\n \"east\": \"\",\n \"west\": \"\"\n },\n \"filters\": {\n \"zoningCategories\": [\n \"\",\n \"\"\n ],\n \"ownerTypes\": [\n \"other\",\n \"corporation\"\n ],\n \"absenteeOnly\": false,\n \"valueRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"yearBuiltRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"acreageRange\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"sort\": \"sale_price\",\n \"order\": \"desc\",\n \"limit\": 100,\n \"offset\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1617f193-80a3-4078-a646-b7376747a253", "name": "Search results returned.", "originalRequest": { "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bounds\": {\n \"north\": \"\",\n \"south\": \"\",\n \"east\": \"\",\n \"west\": \"\"\n },\n \"filters\": {\n \"zoningCategories\": [\n \"\",\n \"\"\n ],\n \"ownerTypes\": [\n \"other\",\n \"corporation\"\n ],\n \"absenteeOnly\": false,\n \"valueRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"yearBuiltRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"acreageRange\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"sort\": \"sale_price\",\n \"order\": \"desc\",\n \"limit\": 100,\n \"offset\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"trust\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"commercial\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"other\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"other\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "375f7e05-2569-4136-b686-e4de00839a95", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bounds\": {\n \"north\": \"\",\n \"south\": \"\",\n \"east\": \"\",\n \"west\": \"\"\n },\n \"filters\": {\n \"zoningCategories\": [\n \"\",\n \"\"\n ],\n \"ownerTypes\": [\n \"other\",\n \"corporation\"\n ],\n \"absenteeOnly\": false,\n \"valueRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"yearBuiltRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"acreageRange\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"sort\": \"sale_price\",\n \"order\": \"desc\",\n \"limit\": 100,\n \"offset\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cff323c-f49d-4db7-a3d4-8530753effdb", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bounds\": {\n \"north\": \"\",\n \"south\": \"\",\n \"east\": \"\",\n \"west\": \"\"\n },\n \"filters\": {\n \"zoningCategories\": [\n \"\",\n \"\"\n ],\n \"ownerTypes\": [\n \"other\",\n \"corporation\"\n ],\n \"absenteeOnly\": false,\n \"valueRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"yearBuiltRange\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"acreageRange\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"sort\": \"sale_price\",\n \"order\": \"desc\",\n \"limit\": 100,\n \"offset\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "autocomplete", "description": "", "item": [ { "id": "977e83df-a54f-4009-9b24-aaec739824f4", "name": "Address / place / parcel autocomplete", "request": { "name": "Address / place / parcel autocomplete", "description": { "content": "Fast prefix-matched autocomplete: returns cities/places, matching parcels, and Mapbox-geocoded addresses for the prefix. Three independent tiers run in parallel with per-tier timeouts so a slow DB query never blocks fast Mapbox results. Use for type-ahead UIs and address entry; for full-detail lookup use parcel lookup.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search prefix. Minimum 2 chars.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7c601412-e526-4e37-97af-90f563de7e3d", "name": "Autocomplete results returned. Empty arrays if `q` is too short or yields no matches.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search prefix. Minimum 2 chars.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"locations\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"parcel_count\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"parcel_count\": \"\"\n }\n ],\n \"parcels\": [\n {\n \"parcel_id\": \"\",\n \"county_fips\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"type\": \"\"\n },\n {\n \"parcel_id\": \"\",\n \"county_fips\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"type\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"lat\": \"\",\n \"lng\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9314e00e-594a-407f-af7a-554d3a4ba0a9", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search prefix. Minimum 2 chars.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01d4487e-f952-4d51-afd2-4d0692db8693", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search prefix. Minimum 2 chars.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "export", "description": "", "item": [ { "id": "9fe500f3-4a12-4972-9e3b-23ca3850da19", "name": "Export search results as CSV", "request": { "name": "Export search results as CSV", "description": { "content": "Returns up to 10,000 search-matched parcels as a CSV download. Accepts the same geographic + attribute filters as POST /api/v1/search. Designed for spreadsheet / Excel workflows; for programmatic ingestion, use the JSON search endpoint and paginate.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "search", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Bounding box: north latitude.", "type": "text/plain" }, "key": "north", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: south latitude.", "type": "text/plain" }, "key": "south", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: east longitude.", "type": "text/plain" }, "key": "east", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: west longitude.", "type": "text/plain" }, "key": "west", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited zoning categories.", "type": "text/plain" }, "key": "zoningCategories", "value": "" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_assessed_value,zoning,year_built,lot_size_acres,ownership_type)", "type": "text/plain" }, "key": "sort", "value": "owner_name" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "Row cap. Hard max 10,000.", "type": "text/plain" }, "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e4b129ab-eab1-4029-ab88-b5b56d7f8549", "name": "CSV file. First row is a header. `Content-Disposition` is set to `attachment`.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Bounding box: north latitude.", "type": "text/plain" }, "key": "north", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: south latitude.", "type": "text/plain" }, "key": "south", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: east longitude.", "type": "text/plain" }, "key": "east", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: west longitude.", "type": "text/plain" }, "key": "west", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited zoning categories.", "type": "text/plain" }, "key": "zoningCategories", "value": "" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_assessed_value,zoning,year_built,lot_size_acres,ownership_type)", "type": "text/plain" }, "key": "sort", "value": "owner_name" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "Row cap. Hard max 10,000.", "type": "text/plain" }, "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79136ce0-d89f-48e3-afe0-507e6c76b245", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Bounding box: north latitude.", "type": "text/plain" }, "key": "north", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: south latitude.", "type": "text/plain" }, "key": "south", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: east longitude.", "type": "text/plain" }, "key": "east", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: west longitude.", "type": "text/plain" }, "key": "west", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited zoning categories.", "type": "text/plain" }, "key": "zoningCategories", "value": "" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_assessed_value,zoning,year_built,lot_size_acres,ownership_type)", "type": "text/plain" }, "key": "sort", "value": "owner_name" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "Row cap. Hard max 10,000.", "type": "text/plain" }, "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a251de-71c6-485d-becb-150c739ccf0d", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Bounding box: north latitude.", "type": "text/plain" }, "key": "north", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: south latitude.", "type": "text/plain" }, "key": "south", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: east longitude.", "type": "text/plain" }, "key": "east", "value": "" }, { "disabled": false, "description": { "content": "Bounding box: west longitude.", "type": "text/plain" }, "key": "west", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited zoning categories.", "type": "text/plain" }, "key": "zoningCategories", "value": "" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_assessed_value,zoning,year_built,lot_size_acres,ownership_type)", "type": "text/plain" }, "key": "sort", "value": "owner_name" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "Row cap. Hard max 10,000.", "type": "text/plain" }, "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "full", "description": "", "item": [ { "id": "ebd13015-d4eb-4915-a26f-258b7874e079", "name": "Full paginated text + attribute search", "request": { "name": "Full paginated text + attribute search", "description": { "content": "Paginated search across the parcel search index by free-text query (`q`) and optional field/state/city filters. Distinct from POST /api/v1/search which is geo-bounded; this endpoint is text-anchored and works without a bounding box. Returns 50/page by default, 200 max.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "search", "full" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query. Min 2 chars.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to match against. (This can only be one of all,address,owner_name,city)", "type": "text/plain" }, "key": "field", "value": "all" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "City filter.", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "1-indexed page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size, max 200.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_value,year_built)", "type": "text/plain" }, "key": "sort", "value": "address" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "dir", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0846d88e-95d6-4558-b920-e8a4d61c1e32", "name": "Paginated search results.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "full" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query. Min 2 chars.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to match against. (This can only be one of all,address,owner_name,city)", "type": "text/plain" }, "key": "field", "value": "all" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "City filter.", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "1-indexed page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size, max 200.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_value,year_built)", "type": "text/plain" }, "key": "sort", "value": "address" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "dir", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"results\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"government\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"industrial\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"government\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"agricultural\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"pages\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a97ec969-9b1f-4414-bd5e-b3904a41d433", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "full" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query. Min 2 chars.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to match against. (This can only be one of all,address,owner_name,city)", "type": "text/plain" }, "key": "field", "value": "all" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "City filter.", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "1-indexed page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size, max 200.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_value,year_built)", "type": "text/plain" }, "key": "sort", "value": "address" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "dir", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57bcc742-b4de-4209-b92c-10942bb3aba4", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "search", "full" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query. Min 2 chars.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to match against. (This can only be one of all,address,owner_name,city)", "type": "text/plain" }, "key": "field", "value": "all" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "City filter.", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "1-indexed page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size, max 200.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Sort column. (This can only be one of address,city,state,owner_name,total_value,year_built)", "type": "text/plain" }, "key": "sort", "value": "address" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "dir", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "coverage", "description": "", "item": [ { "id": "70b34fbd-4896-4bbd-b9b1-552750cb3273", "name": "Get coverage statistics", "request": { "name": "Get coverage statistics", "description": { "content": "Retrieve parcel coverage statistics at the state or county level.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "coverage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "State FIPS code or abbreviation to filter coverage to a specific state and return county-level breakdown.", "type": "text/plain" }, "key": "state", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0e35e8fe-98d4-4c78-8251-910c94da036d", "name": "Coverage data returned.", "originalRequest": { "url": { "path": [ "api", "v1", "coverage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "State FIPS code or abbreviation to filter coverage to a specific state and return county-level breakdown.", "type": "text/plain" }, "key": "state", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"total_parcels\": \"\",\n \"states_covered\": \"\",\n \"data\": [\n {\n \"state_fips\": \"\",\n \"state_name\": \"\",\n \"county_fips\": \"\",\n \"county_name\": \"\",\n \"parcel_count\": \"\",\n \"geocoded_pct\": \"\",\n \"owner_pct\": \"\",\n \"value_pct\": \"\"\n },\n {\n \"state_fips\": \"\",\n \"state_name\": \"\",\n \"county_fips\": \"\",\n \"county_name\": \"\",\n \"parcel_count\": \"\",\n \"geocoded_pct\": \"\",\n \"owner_pct\": \"\",\n \"value_pct\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ba3a8a2-4d59-4576-ae31-cc1e17a81cf8", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "coverage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "State FIPS code or abbreviation to filter coverage to a specific state and return county-level breakdown.", "type": "text/plain" }, "key": "state", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "deals", "description": "", "item": [ { "name": "absentee", "description": "", "item": [ { "id": "2b9b3f59-d73c-4183-92ef-a9e8ac4db155", "name": "Find absentee owners", "request": { "name": "Find absentee owners", "description": { "content": "Retrieve parcels owned by absentee owners, useful for off-market deal sourcing.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "absentee" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value.", "type": "text/plain" }, "key": "min_value", "value": "" }, { "disabled": false, "description": { "content": "Only return owners whose mailing address is in a different state.", "type": "text/plain" }, "key": "out_of_state", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5aec5887-f86e-4863-bb49-0ac4781c3bca", "name": "Absentee owner parcels returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "absentee" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value.", "type": "text/plain" }, "key": "min_value", "value": "" }, { "disabled": false, "description": { "content": "Only return owners whose mailing address is in a different state.", "type": "text/plain" }, "key": "out_of_state", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"llc\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"residential\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"trust\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"residential\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc7446f-9c7a-4bdf-a382-8eb5d6c0ee01", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "absentee" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value.", "type": "text/plain" }, "key": "min_value", "value": "" }, { "disabled": false, "description": { "content": "Only return owners whose mailing address is in a different state.", "type": "text/plain" }, "key": "out_of_state", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdba02f5-0213-4f2b-bc64-b98e3bf7abdb", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "absentee" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value.", "type": "text/plain" }, "key": "min_value", "value": "" }, { "disabled": false, "description": { "content": "Only return owners whose mailing address is in a different state.", "type": "text/plain" }, "key": "out_of_state", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "flips", "description": "", "item": [ { "id": "75d3b70c-359e-45cb-97bc-4d0b4b87d52d", "name": "Find property flips", "request": { "name": "Find property flips", "description": { "content": "Retrieve recently flipped properties. Use ?view=flippers to get a ranked list of top flippers instead.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by flip speed tier (quick: <6mo, standard: 6-12mo, long: 12-24mo). (This can only be one of quick,standard,long)", "type": "text/plain" }, "key": "flip_tier", "value": "long" }, { "disabled": false, "description": { "content": "Minimum estimated profit.", "type": "text/plain" }, "key": "min_profit", "value": "" }, { "disabled": false, "description": { "content": "Set to 'flippers' to return a ranked list of top flippers instead of individual flips. (This can only be one of flippers)", "type": "text/plain" }, "key": "view", "value": "flippers" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "28328a9a-140a-4d22-829e-2d1cc74e03be", "name": "Flips or flippers returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by flip speed tier (quick: <6mo, standard: 6-12mo, long: 12-24mo). (This can only be one of quick,standard,long)", "type": "text/plain" }, "key": "flip_tier", "value": "long" }, { "disabled": false, "description": { "content": "Minimum estimated profit.", "type": "text/plain" }, "key": "min_profit", "value": "" }, { "disabled": false, "description": { "content": "Set to 'flippers' to return a ranked list of top flippers instead of individual flips. (This can only be one of flippers)", "type": "text/plain" }, "key": "view", "value": "flippers" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"address\": \"\",\n \"buy_date\": \"\",\n \"buy_price\": \"\",\n \"sell_date\": \"\",\n \"sell_price\": \"\",\n \"profit\": \"\",\n \"hold_days\": \"\",\n \"flip_tier\": \"long\",\n \"buyer_name\": \"\",\n \"seller_name\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"address\": \"\",\n \"buy_date\": \"\",\n \"buy_price\": \"\",\n \"sell_date\": \"\",\n \"sell_price\": \"\",\n \"profit\": \"\",\n \"hold_days\": \"\",\n \"flip_tier\": \"standard\",\n \"buyer_name\": \"\",\n \"seller_name\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c73d81e-2ec8-4524-a608-0be3702c789d", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by flip speed tier (quick: <6mo, standard: 6-12mo, long: 12-24mo). (This can only be one of quick,standard,long)", "type": "text/plain" }, "key": "flip_tier", "value": "long" }, { "disabled": false, "description": { "content": "Minimum estimated profit.", "type": "text/plain" }, "key": "min_profit", "value": "" }, { "disabled": false, "description": { "content": "Set to 'flippers' to return a ranked list of top flippers instead of individual flips. (This can only be one of flippers)", "type": "text/plain" }, "key": "view", "value": "flippers" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48a5eb15-23b6-4079-a30b-9b68045ec13d", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by county FIPS code.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by flip speed tier (quick: <6mo, standard: 6-12mo, long: 12-24mo). (This can only be one of quick,standard,long)", "type": "text/plain" }, "key": "flip_tier", "value": "long" }, { "disabled": false, "description": { "content": "Minimum estimated profit.", "type": "text/plain" }, "key": "min_profit", "value": "" }, { "disabled": false, "description": { "content": "Set to 'flippers' to return a ranked list of top flippers instead of individual flips. (This can only be one of flippers)", "type": "text/plain" }, "key": "view", "value": "flippers" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "contractors", "description": "", "item": [ { "id": "23b75f04-146a-4ce6-a6fe-f4161704fe97", "name": "Search contractors by permit activity", "request": { "name": "Search contractors by permit activity", "description": { "content": "Returns contractor profiles aggregated from 45M+ building permits. Each profile includes permit count, jurisdictions worked, total declared permit value, and activity dates. Use to identify active contractors in a market or find a specific contractor by name.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "contractors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Contractor name search (case-insensitive substring).", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum permit count to include.", "type": "text/plain" }, "key": "min_permits", "value": "3" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total declared permit value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7c45ff2-6dff-4cf9-b723-e22cded60b70", "name": "Contractor profiles returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "contractors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Contractor name search (case-insensitive substring).", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum permit count to include.", "type": "text/plain" }, "key": "min_permits", "value": "3" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total declared permit value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"contractor_name_normalized\": \"\",\n \"contractor_license\": \"\",\n \"permit_count\": \"\",\n \"jurisdiction_count\": \"\",\n \"state_count\": \"\",\n \"county_count\": \"\",\n \"total_permit_value\": \"\",\n \"avg_permit_value\": \"\",\n \"first_permit_date\": \"\",\n \"last_permit_date\": \"\",\n \"active_years\": \"\",\n \"top_permit_types\": [\n \"\",\n \"\"\n ],\n \"states_list\": \"\",\n \"contractor_rank\": \"\"\n },\n {\n \"contractor_name_normalized\": \"\",\n \"contractor_license\": \"\",\n \"permit_count\": \"\",\n \"jurisdiction_count\": \"\",\n \"state_count\": \"\",\n \"county_count\": \"\",\n \"total_permit_value\": \"\",\n \"avg_permit_value\": \"\",\n \"first_permit_date\": \"\",\n \"last_permit_date\": \"\",\n \"active_years\": \"\",\n \"top_permit_types\": null,\n \"states_list\": \"\",\n \"contractor_rank\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee570652-a407-4c4b-9e62-5f7d82946b42", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "contractors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Contractor name search (case-insensitive substring).", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum permit count to include.", "type": "text/plain" }, "key": "min_permits", "value": "3" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total declared permit value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ec7ffcb-60ea-4314-9496-854cbf016fe1", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "contractors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Contractor name search (case-insensitive substring).", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum permit count to include.", "type": "text/plain" }, "key": "min_permits", "value": "3" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total declared permit value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "entities", "description": "", "item": [ { "id": "7a2b36f3-11ab-4b27-befd-4ced29e1c3a4", "name": "Find entity-owned parcels (LLC, Corp, Trust, LP)", "request": { "name": "Find entity-owned parcels (LLC, Corp, Trust, LP)", "description": { "content": "Returns parcels owned by legal entities identified from owner-name pattern matching across 221M+ parcels. Pass `top=true` to get aggregated entity rankings instead of per-parcel rows. One of `county_fips`, `state_fips`, `search`, or `top` is required.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "entities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by entity classification. (This can only be one of LLC,CORP,TRUST,LP,LTD,ASSOCIATION,OTHER_ENTITY)", "type": "text/plain" }, "key": "entity_type", "value": "LP" }, { "disabled": false, "description": { "content": "Owner-name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "If true, returns aggregated entity rankings with summary stats instead of per-parcel rows.", "type": "text/plain" }, "key": "top", "value": "false" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4d9553f1-7b45-44bb-a7cf-61d7a038f1c0", "name": "Entity-owned parcels or top-entity aggregates returned. Shape varies with the `top` parameter.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "entities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by entity classification. (This can only be one of LLC,CORP,TRUST,LP,LTD,ASSOCIATION,OTHER_ENTITY)", "type": "text/plain" }, "key": "entity_type", "value": "LP" }, { "disabled": false, "description": { "content": "Owner-name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "If true, returns aggregated entity rankings with summary stats instead of per-parcel rows.", "type": "text/plain" }, "key": "top", "value": "false" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"parcel_id\": \"\",\n \"owner_name\": \"\",\n \"entity_type\": \"OTHER_ENTITY\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"total_assessed_value\": \"\",\n \"zoning\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"parcel_id\": \"\",\n \"owner_name\": \"\",\n \"entity_type\": \"OTHER_ENTITY\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"total_assessed_value\": \"\",\n \"zoning\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61717d8c-7099-451d-affa-8dccefdcff67", "name": "One of county_fips, state_fips, search, or top is required.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "entities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by entity classification. (This can only be one of LLC,CORP,TRUST,LP,LTD,ASSOCIATION,OTHER_ENTITY)", "type": "text/plain" }, "key": "entity_type", "value": "LP" }, { "disabled": false, "description": { "content": "Owner-name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "If true, returns aggregated entity rankings with summary stats instead of per-parcel rows.", "type": "text/plain" }, "key": "top", "value": "false" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "268e9b70-a513-4f19-af2a-d3b823a35791", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "entities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by entity classification. (This can only be one of LLC,CORP,TRUST,LP,LTD,ASSOCIATION,OTHER_ENTITY)", "type": "text/plain" }, "key": "entity_type", "value": "LP" }, { "disabled": false, "description": { "content": "Owner-name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "If true, returns aggregated entity rankings with summary stats instead of per-parcel rows.", "type": "text/plain" }, "key": "top", "value": "false" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95ee94d5-aa2c-4511-869a-cc90f557ab9a", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "entities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Filter by entity classification. (This can only be one of LLC,CORP,TRUST,LP,LTD,ASSOCIATION,OTHER_ENTITY)", "type": "text/plain" }, "key": "entity_type", "value": "LP" }, { "disabled": false, "description": { "content": "Owner-name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "If true, returns aggregated entity rankings with summary stats instead of per-parcel rows.", "type": "text/plain" }, "key": "top", "value": "false" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "high-land-ratio", "description": "", "item": [ { "id": "ee9635b2-a5ae-4261-bf01-4a00dc8b76cd", "name": "Find parcels with high land-to-improvement ratio", "request": { "name": "Find parcels with high land-to-improvement ratio", "description": { "content": "Returns parcels where land value significantly exceeds improvement value — a signal for redevelopment, teardown, or assemblage opportunities. `county_fips` or `state_fips` is required.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "high-land-ratio" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum land/improvement ratio.", "type": "text/plain" }, "key": "min_ratio", "value": "3" }, { "disabled": false, "description": { "content": "Minimum land assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "217441b7-d263-4502-be90-97496eff7e8b", "name": "High land-to-improvement-ratio parcels returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "high-land-ratio" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum land/improvement ratio.", "type": "text/plain" }, "key": "min_ratio", "value": "3" }, { "disabled": false, "description": { "content": "Minimum land assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"parcel_id\": \"\",\n \"owner_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"land_assessed_value\": \"\",\n \"improvement_assessed_value\": \"\",\n \"total_assessed_value\": \"\",\n \"land_improvement_ratio\": \"\",\n \"zoning\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"parcel_id\": \"\",\n \"owner_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"land_assessed_value\": \"\",\n \"improvement_assessed_value\": \"\",\n \"total_assessed_value\": \"\",\n \"land_improvement_ratio\": \"\",\n \"zoning\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "817f2f48-6ffe-4205-bc22-35464304dd68", "name": "Either county_fips or state_fips is required.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "high-land-ratio" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum land/improvement ratio.", "type": "text/plain" }, "key": "min_ratio", "value": "3" }, { "disabled": false, "description": { "content": "Minimum land assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6dc50ae-3a4a-4f24-bc3b-961d742e2bca", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "high-land-ratio" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum land/improvement ratio.", "type": "text/plain" }, "key": "min_ratio", "value": "3" }, { "disabled": false, "description": { "content": "Minimum land assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d952408-1612-414f-ad66-a62480f60369", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "high-land-ratio" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum land/improvement ratio.", "type": "text/plain" }, "key": "min_ratio", "value": "3" }, { "disabled": false, "description": { "content": "Minimum land assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Zoning substring filter.", "type": "text/plain" }, "key": "zoning", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "lenders", "description": "", "item": [ { "id": "a2109fef-c610-4426-84b0-0dafebaa1cf6", "name": "Search lender profiles", "request": { "name": "Search lender profiles", "description": { "content": "Returns lender profiles aggregated from deed/mortgage transactions. Includes mortgage count, total volume, geographic spread, and a national rank.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "lenders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lender name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum mortgage count.", "type": "text/plain" }, "key": "min_mortgages", "value": "2" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6d74461c-0118-4f4c-b473-3b26e7fff736", "name": "Lender profiles returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "lenders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lender name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum mortgage count.", "type": "text/plain" }, "key": "min_mortgages", "value": "2" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"lender_name_normalized\": \"\",\n \"mortgage_count\": \"\",\n \"total_mortgage_volume\": \"\",\n \"avg_mortgage_amount\": \"\",\n \"median_mortgage_amount\": \"\",\n \"county_count\": \"\",\n \"state_count\": \"\",\n \"states_list\": \"\",\n \"first_mortgage_date\": \"\",\n \"last_mortgage_date\": \"\",\n \"lender_rank\": \"\"\n },\n {\n \"lender_name_normalized\": \"\",\n \"mortgage_count\": \"\",\n \"total_mortgage_volume\": \"\",\n \"avg_mortgage_amount\": \"\",\n \"median_mortgage_amount\": \"\",\n \"county_count\": \"\",\n \"state_count\": \"\",\n \"states_list\": \"\",\n \"first_mortgage_date\": \"\",\n \"last_mortgage_date\": \"\",\n \"lender_rank\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfb1ddc0-6e05-49f8-96b6-4ff787816173", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "lenders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lender name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum mortgage count.", "type": "text/plain" }, "key": "min_mortgages", "value": "2" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "583592af-dba4-434f-afae-1cfb41abb5a9", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "lenders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lender name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Minimum mortgage count.", "type": "text/plain" }, "key": "min_mortgages", "value": "2" }, { "disabled": false, "description": { "content": "2-letter state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "long-hold", "description": "", "item": [ { "id": "e0faf5f9-32fc-485e-b1cc-c2acd2992286", "name": "Find long-held parcels (10+ years)", "request": { "name": "Find long-held parcels (10+ years)", "description": { "content": "Returns parcels not sold in `min_years` or more. Long-hold owners are often motivated sellers — estate planning, deferred maintenance, life changes. `county_fips` or `state_fips` is required.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "long-hold" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum years held.", "type": "text/plain" }, "key": "min_years", "value": "10" }, { "disabled": false, "description": { "content": "Filter by hold-period tier. (This can only be one of 10-15yr,15-20yr,20-30yr,30yr+)", "type": "text/plain" }, "key": "hold_tier", "value": "10-15yr" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cef5f5ad-a3c3-46f1-b672-6c73c833d2fb", "name": "Long-hold parcels returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "long-hold" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum years held.", "type": "text/plain" }, "key": "min_years", "value": "10" }, { "disabled": false, "description": { "content": "Filter by hold-period tier. (This can only be one of 10-15yr,15-20yr,20-30yr,30yr+)", "type": "text/plain" }, "key": "hold_tier", "value": "10-15yr" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"parcel_id\": \"\",\n \"owner_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"last_sale_date\": \"\",\n \"years_held\": \"\",\n \"hold_tier\": \"15-20yr\",\n \"total_assessed_value\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"parcel_id\": \"\",\n \"owner_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"last_sale_date\": \"\",\n \"years_held\": \"\",\n \"hold_tier\": \"15-20yr\",\n \"total_assessed_value\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4749f20-e17c-404e-92fd-6b9fcf05ac6a", "name": "Either county_fips or state_fips is required.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "long-hold" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum years held.", "type": "text/plain" }, "key": "min_years", "value": "10" }, { "disabled": false, "description": { "content": "Filter by hold-period tier. (This can only be one of 10-15yr,15-20yr,20-30yr,30yr+)", "type": "text/plain" }, "key": "hold_tier", "value": "10-15yr" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7354f57-941b-48df-8bef-edaeeb233c0a", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "long-hold" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum years held.", "type": "text/plain" }, "key": "min_years", "value": "10" }, { "disabled": false, "description": { "content": "Filter by hold-period tier. (This can only be one of 10-15yr,15-20yr,20-30yr,30yr+)", "type": "text/plain" }, "key": "hold_tier", "value": "10-15yr" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05e123c-de5a-4774-b047-087994266e51", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "long-hold" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum years held.", "type": "text/plain" }, "key": "min_years", "value": "10" }, { "disabled": false, "description": { "content": "Filter by hold-period tier. (This can only be one of 10-15yr,15-20yr,20-30yr,30yr+)", "type": "text/plain" }, "key": "hold_tier", "value": "10-15yr" }, { "disabled": false, "description": { "content": "Minimum assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "market", "description": "", "item": [ { "id": "8e72d09c-e999-43a2-9970-36d74e4025e3", "name": "County-quarter transaction summary or affordability index", "request": { "name": "County-quarter transaction summary or affordability index", "description": { "content": "Default: returns county/quarter transaction summaries. Pass `view=affordability` to retrieve the home-affordability index instead (price-to-income ratios + rating).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Switch to the affordability-index dataset. (This can only be one of affordability)", "type": "text/plain" }, "key": "view", "value": "affordability" }, { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Year filter.", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Affordability-rating filter (only meaningful with view=affordability). (This can only be one of AFFORDABLE,MODERATE,EXPENSIVE,VERY_EXPENSIVE)", "type": "text/plain" }, "key": "rating", "value": "MODERATE" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "22592277-a73c-4aff-812e-a8c556f4d44a", "name": "Market summary or affordability rows returned. Shape varies with the `view` parameter.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Switch to the affordability-index dataset. (This can only be one of affordability)", "type": "text/plain" }, "key": "view", "value": "affordability" }, { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Year filter.", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Affordability-rating filter (only meaningful with view=affordability). (This can only be one of AFFORDABLE,MODERATE,EXPENSIVE,VERY_EXPENSIVE)", "type": "text/plain" }, "key": "rating", "value": "MODERATE" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"county_name\": \"\",\n \"year\": \"\",\n \"sale_count\": \"\",\n \"median_sale_price\": \"\",\n \"avg_sale_price\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"county_name\": \"\",\n \"year\": \"\",\n \"sale_count\": \"\",\n \"median_sale_price\": \"\",\n \"avg_sale_price\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12979605-d72f-4799-adb3-ea6dab999ef8", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Switch to the affordability-index dataset. (This can only be one of affordability)", "type": "text/plain" }, "key": "view", "value": "affordability" }, { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Year filter.", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Affordability-rating filter (only meaningful with view=affordability). (This can only be one of AFFORDABLE,MODERATE,EXPENSIVE,VERY_EXPENSIVE)", "type": "text/plain" }, "key": "rating", "value": "MODERATE" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ecc185-48ae-46e7-bc4e-061c92d7603e", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Switch to the affordability-index dataset. (This can only be one of affordability)", "type": "text/plain" }, "key": "view", "value": "affordability" }, { "disabled": false, "description": { "content": "5-digit county FIPS filter.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Year filter.", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Affordability-rating filter (only meaningful with view=affordability). (This can only be one of AFFORDABLE,MODERATE,EXPENSIVE,VERY_EXPENSIVE)", "type": "text/plain" }, "key": "rating", "value": "MODERATE" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "portfolio-owners", "description": "", "item": [ { "id": "459b85af-9e85-4682-adf3-a81ff57ecfae", "name": "Find portfolio investors (owners of 2+ properties)", "request": { "name": "Find portfolio investors (owners of 2+ properties)", "description": { "content": "Returns portfolio owners ranked by property count and total assessed value. Useful for finding institutional buyers, small landlords, or specific investor families.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "deals", "portfolio-owners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Minimum properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "2" }, { "disabled": false, "description": { "content": "2-letter owner mailing state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total portfolio assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Owner name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3f6e5134-6a75-4696-9d57-01d0032de9c5", "name": "Portfolio owners returned.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "portfolio-owners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Minimum properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "2" }, { "disabled": false, "description": { "content": "2-letter owner mailing state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total portfolio assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Owner name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"owner_name_normalized\": \"\",\n \"owner_state\": \"\",\n \"property_count\": \"\",\n \"state_count\": \"\",\n \"county_count\": \"\",\n \"total_assessed_value\": \"\",\n \"avg_assessed_value\": \"\",\n \"total_acreage\": \"\",\n \"states_list\": \"\",\n \"portfolio_rank\": \"\"\n },\n {\n \"owner_name_normalized\": \"\",\n \"owner_state\": \"\",\n \"property_count\": \"\",\n \"state_count\": \"\",\n \"county_count\": \"\",\n \"total_assessed_value\": \"\",\n \"avg_assessed_value\": \"\",\n \"total_acreage\": \"\",\n \"states_list\": \"\",\n \"portfolio_rank\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "942c7b94-66cd-41ce-a89b-53fc3a15a492", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "portfolio-owners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Minimum properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "2" }, { "disabled": false, "description": { "content": "2-letter owner mailing state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total portfolio assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Owner name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab216704-91d1-49c9-9735-b50970d8d67d", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "deals", "portfolio-owners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Minimum properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "2" }, { "disabled": false, "description": { "content": "2-letter owner mailing state filter.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "Minimum total portfolio assessed value, USD.", "type": "text/plain" }, "key": "min_value", "value": "0" }, { "disabled": false, "description": { "content": "Owner name substring search.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "market", "description": "", "item": [ { "name": "counties", "description": "", "item": [ { "id": "e1271b0b-e4e3-4fe5-aee2-afa1f8b7d2b7", "name": "Get county market statistics", "request": { "name": "Get county market statistics", "description": { "content": "Retrieve real estate market statistics aggregated at the county level, including sale counts, median prices, and year-over-year changes.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "market", "counties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of sales in the period to include a county.", "type": "text/plain" }, "key": "min_sales", "value": "" }, { "disabled": false, "description": { "content": "Specific quarter to retrieve (e.g., 2025Q4). Defaults to latest available.", "type": "text/plain" }, "key": "quarter", "value": "" }, { "disabled": false, "description": { "content": "Sort field. (This can only be one of sale_count,median_price,yoy_change,county_name)", "type": "text/plain" }, "key": "sort", "value": "sale_count" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9dc30de9-6a08-4823-8c2d-ea3aa949f397", "name": "County market stats returned.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of sales in the period to include a county.", "type": "text/plain" }, "key": "min_sales", "value": "" }, { "disabled": false, "description": { "content": "Specific quarter to retrieve (e.g., 2025Q4). Defaults to latest available.", "type": "text/plain" }, "key": "quarter", "value": "" }, { "disabled": false, "description": { "content": "Sort field. (This can only be one of sale_count,median_price,yoy_change,county_name)", "type": "text/plain" }, "key": "sort", "value": "sale_count" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"county_name\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_price\": \"\",\n \"avg_price\": \"\",\n \"yoy_change\": \"\",\n \"avg_days_on_market\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"county_name\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_price\": \"\",\n \"avg_price\": \"\",\n \"yoy_change\": \"\",\n \"avg_days_on_market\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba6e395-ce02-4c71-b4d9-ce886953272a", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of sales in the period to include a county.", "type": "text/plain" }, "key": "min_sales", "value": "" }, { "disabled": false, "description": { "content": "Specific quarter to retrieve (e.g., 2025Q4). Defaults to latest available.", "type": "text/plain" }, "key": "quarter", "value": "" }, { "disabled": false, "description": { "content": "Sort field. (This can only be one of sale_count,median_price,yoy_change,county_name)", "type": "text/plain" }, "key": "sort", "value": "sale_count" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fb7871c-6ab7-4daa-b4c1-eea7adb207b1", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by state FIPS code.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of sales in the period to include a county.", "type": "text/plain" }, "key": "min_sales", "value": "" }, { "disabled": false, "description": { "content": "Specific quarter to retrieve (e.g., 2025Q4). Defaults to latest available.", "type": "text/plain" }, "key": "quarter", "value": "" }, { "disabled": false, "description": { "content": "Sort field. (This can only be one of sale_count,median_price,yoy_change,county_name)", "type": "text/plain" }, "key": "sort", "value": "sale_count" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{fips}", "description": "", "item": [ { "id": "a9f432b3-a80f-4bfd-89ff-10287ff2a439", "name": "Detailed view for a single county", "request": { "name": "Detailed view for a single county", "description": { "content": "Returns the full county profile: quarterly market stats (sale count, median price, YoY change, days on market), affordability index by year, parcel summary (count, avg assessed value), and flip activity. Use for county-detail dashboards.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "market", "counties", ":fips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "06544", "key": "fips", "disabled": false, "description": { "content": "(Required) 5-digit county FIPS code.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f284952b-dfe1-440b-8e66-391df7660984", "name": "County detail returned.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties", ":fips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 5-digit county FIPS code.", "type": "text/plain" }, "type": "any", "value": "06544", "key": "fips" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"market_stats\": [\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_sale_price\": \"\",\n \"avg_sale_price\": \"\",\n \"total_volume\": \"\",\n \"price_yoy_pct\": \"\",\n \"avg_dom\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_sale_price\": \"\",\n \"avg_sale_price\": \"\",\n \"total_volume\": \"\",\n \"price_yoy_pct\": \"\",\n \"avg_dom\": \"\"\n }\n ],\n \"affordability\": [\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"county_name\": \"\",\n \"year\": \"\",\n \"median_sale_price\": \"\",\n \"median_household_income\": \"\",\n \"price_to_income_ratio\": \"\",\n \"monthly_payment_estimate\": \"\",\n \"pct_income_for_housing\": \"\",\n \"affordability_rating\": \"AFFORDABLE\"\n },\n {\n \"county_fips\": \"\",\n \"state_fips\": \"\",\n \"county_name\": \"\",\n \"year\": \"\",\n \"median_sale_price\": \"\",\n \"median_household_income\": \"\",\n \"price_to_income_ratio\": \"\",\n \"monthly_payment_estimate\": \"\",\n \"pct_income_for_housing\": \"\",\n \"affordability_rating\": \"EXPENSIVE\"\n }\n ],\n \"parcel_summary\": {\n \"parcel_count\": \"\",\n \"avg_assessed_value\": \"\"\n },\n \"flip_summary\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e525180-ddcb-4929-9cf9-877280cca585", "name": "Invalid FIPS code.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties", ":fips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 5-digit county FIPS code.", "type": "text/plain" }, "type": "any", "value": "06544", "key": "fips" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df97dbef-0084-4de0-9de3-1f7bcefc5ae8", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties", ":fips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 5-digit county FIPS code.", "type": "text/plain" }, "type": "any", "value": "06544", "key": "fips" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c76e8378-001a-44e0-8487-b0a7dc703927", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties", ":fips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 5-digit county FIPS code.", "type": "text/plain" }, "type": "any", "value": "06544", "key": "fips" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "173a293f-94fd-4a25-94d1-30b62b48b510", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "counties", ":fips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 5-digit county FIPS code.", "type": "text/plain" }, "type": "any", "value": "06544", "key": "fips" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "trends", "description": "", "item": [ { "id": "243650d2-1ec5-4921-8ca0-4158d64ca108", "name": "Get market trends", "request": { "name": "Get market trends", "description": { "content": "Retrieve quarterly time series of market metrics for one or more counties or a state.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "market", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of county FIPS codes.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "State FIPS code. Used if county_fips is not provided.", "type": "text/plain" }, "key": "state_fips", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "262f36ec-8d3e-41d5-a755-c8a558fd20e7", "name": "Market trend time series returned.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of county FIPS codes.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "State FIPS code. Used if county_fips is not provided.", "type": "text/plain" }, "key": "state_fips", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"county_name\": \"\",\n \"quarters\": [\n {\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_price\": \"\",\n \"avg_price\": \"\",\n \"yoy_change\": \"\"\n },\n {\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_price\": \"\",\n \"avg_price\": \"\",\n \"yoy_change\": \"\"\n }\n ]\n },\n {\n \"county_fips\": \"\",\n \"county_name\": \"\",\n \"quarters\": [\n {\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_price\": \"\",\n \"avg_price\": \"\",\n \"yoy_change\": \"\"\n },\n {\n \"quarter\": \"\",\n \"sale_count\": \"\",\n \"median_price\": \"\",\n \"avg_price\": \"\",\n \"yoy_change\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5effe9b7-14a5-4e8f-9ef0-3d613063358e", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of county FIPS codes.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "State FIPS code. Used if county_fips is not provided.", "type": "text/plain" }, "key": "state_fips", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00279f80-ee9c-4e0b-b9ce-c81e5abad044", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of county FIPS codes.", "type": "text/plain" }, "key": "county_fips", "value": "" }, { "disabled": false, "description": { "content": "State FIPS code. Used if county_fips is not provided.", "type": "text/plain" }, "key": "state_fips", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "flips", "description": "", "item": [ { "id": "4ab2f413-1c94-4d29-b92c-9688bdac3aaf", "name": "Flip-activity summary grouped by county", "request": { "name": "Flip-activity summary grouped by county", "description": { "content": "Aggregated flip activity per county: count, average ROI, average hold days, total profit. Use for surfacing the hottest flip markets. Differs from /api/v1/deals/flips which returns the underlying transactions.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "market", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db6fe04f-6d27-434b-8369-9d8041363ac8", "name": "Flip summary by county.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"flip_count\": \"\",\n \"avg_roi\": \"\",\n \"avg_hold_days\": \"\",\n \"total_profit\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"flip_count\": \"\",\n \"avg_roi\": \"\",\n \"avg_hold_days\": \"\",\n \"total_profit\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599e5816-7a3d-4c0c-9af5-9ed324c8aa43", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b627b7fc-858a-4309-b6d2-bb85a835028d", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "market", "flips" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "2-digit state FIPS filter.", "type": "text/plain" }, "key": "state_fips", "value": "" }, { "disabled": false, "description": { "content": "Page size, max 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Pagination offset.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "owners", "description": "", "item": [ { "name": "search", "description": "", "item": [ { "id": "cbb0cfb3-a111-4ad8-99d8-f03a981e2768", "name": "Search property owners", "request": { "name": "Search property owners", "description": { "content": "Search for property owners by name. Returns owner profiles with property counts and portfolio values.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "owners", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query for owner name.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "208cc6cb-d449-4618-a3cd-31e516717d4b", "name": "Owner search results returned.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query for owner name.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"owner_name\": \"\",\n \"entity_type\": \"corporation\",\n \"property_count\": \"\",\n \"total_assessed_value\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n },\n {\n \"owner_name\": \"\",\n \"entity_type\": \"llc\",\n \"property_count\": \"\",\n \"total_assessed_value\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e8576ad-f419-416d-a254-1649efa6e018", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query for owner name.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "663d13e3-f0c3-4e95-9211-16764f5faab7", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query for owner name.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of properties owned.", "type": "text/plain" }, "key": "min_properties", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{name}", "description": "", "item": [ { "id": "ba975b9c-37a6-4d7f-9452-73d48abb675e", "name": "Get owner profile", "request": { "name": "Get owner profile", "description": { "content": "Retrieve a specific owner profile by name, including property count, total assessed value, entity type, and states.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "owners", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "name", "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2c862049-f1b2-4c0d-9140-0f532257e10c", "name": "Owner profile returned.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"owner_name\": \"\",\n \"entity_type\": \"other\",\n \"property_count\": \"\",\n \"total_assessed_value\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9baeceb7-432e-4f05-9580-3db251bb30db", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a752d0bd-a657-4d44-bca3-8f75592ae9c5", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1d04818-f40c-4ac0-b683-3d999861e11c", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "properties", "description": "", "item": [ { "id": "f539fd12-9482-48dd-a0b5-8e7b55c961da", "name": "Get owner's properties", "request": { "name": "Get owner's properties", "description": { "content": "Retrieve the list of properties owned by a specific owner.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "owners", ":name", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "type": "any", "value": "", "key": "name", "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "55c187e9-e855-4ff1-a845-83941654ff0f", "name": "Owner properties returned.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"llc\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"residential\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"trust\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"residential\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb45c1d-6016-4e5a-b263-00b151efc573", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb1d3d3-5b18-4557-857c-325612827932", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdb8a611-3ad9-407c-974e-00d7a1fd0a90", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "portfolio", "description": "", "item": [ { "id": "efcf3399-7e59-413d-81d0-27721818d689", "name": "Get owner portfolio summary", "request": { "name": "Get owner portfolio summary", "description": { "content": "Retrieve an owner's portfolio with aggregated summary statistics and property breakdown.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "owners", ":name", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "name", "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "674985cb-b45f-469a-a956-bfd78fc304be", "name": "Owner portfolio returned.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"owner_name\": \"\",\n \"entity_type\": \"llc\",\n \"summary\": {\n \"property_count\": \"\",\n \"total_assessed_value\": \"\",\n \"avg_assessed_value\": \"\",\n \"states\": [\n \"\",\n \"\"\n ],\n \"counties\": \"\",\n \"zoning_breakdown\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"properties\": [\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"llc\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"residential\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n },\n {\n \"county_fips\": \"\",\n \"parcel_id\": \"\",\n \"state_fips\": \"\",\n \"state_abbr\": \"\",\n \"county_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"owner_name\": \"\",\n \"owner_type\": \"other\",\n \"mailing_address\": \"\",\n \"assessed_value\": \"\",\n \"land_value\": \"\",\n \"improvement_value\": \"\",\n \"market_value\": \"\",\n \"acreage\": \"\",\n \"year_built\": \"\",\n \"zoning\": \"\",\n \"zoning_category\": \"other\",\n \"land_use\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"last_sale_date\": \"\",\n \"last_sale_price\": \"\",\n \"absentee_owner\": \"\",\n \"crime_score\": \"\",\n \"deal_score\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e960659-0741-4126-9842-93b587f83e3c", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63d5307d-5d38-458a-a66a-d6dd7cee9233", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "813f2542-ad2b-457b-b148-e798dcaa0320", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name (URL-encoded).", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "transactions", "description": "", "item": [ { "id": "c355d783-526e-47e9-b755-26155ccc633b", "name": "Recorded deed transactions for an owner", "request": { "name": "Recorded deed transactions for an owner", "description": { "content": "Returns up to 100 most-recent deed events where the named owner is either grantor or grantee. Useful for building an owner's transaction timeline across their portfolio.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "owners", ":name", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "name", "disabled": false, "description": { "content": "(Required) Owner name. URL-encoded; case-insensitive trimmed match against grantor / grantee.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b174b012-d554-46ae-a157-066d3557e3fe", "name": "Transactions returned. Newest first. Capped at 100.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name. URL-encoded; case-insensitive trimmed match against grantor / grantee.", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"document_number\": \"\",\n \"recording_date\": \"\",\n \"sale_date\": \"\",\n \"document_type\": \"\",\n \"sale_price\": \"\",\n \"grantor_name\": \"\",\n \"grantee_name\": \"\",\n \"property_address\": \"\"\n },\n {\n \"document_number\": \"\",\n \"recording_date\": \"\",\n \"sale_date\": \"\",\n \"document_type\": \"\",\n \"sale_price\": \"\",\n \"grantor_name\": \"\",\n \"grantee_name\": \"\",\n \"property_address\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f48af06c-c5ad-4bbf-afe2-ad64496331d6", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name. URL-encoded; case-insensitive trimmed match against grantor / grantee.", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9542fce5-69b0-4cdf-a93f-1a26ab24b134", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name. URL-encoded; case-insensitive trimmed match against grantor / grantee.", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeee6ed2-a318-4461-9708-f8b959b5f65c", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "owners", ":name", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owner name. URL-encoded; case-insensitive trimmed match against grantor / grantee.", "type": "text/plain" }, "type": "any", "value": "", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "edae0323-04c6-43cb-83b5-9db47047c39a", "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": { "content": "Returns all webhook endpoints for the calling account, plus the per-tier quota.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "deec5fe4-5d2b-497c-8bc6-c89a808cf3d7", "name": "Webhook endpoints returned.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"webhooks\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"secret_prefix\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\",\n \"parcel.sold\"\n ],\n \"filter_kind\": \"state_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"disabled_at\": \"\",\n \"disabled_reason\": \"\",\n \"deliveries_attempted\": \"\",\n \"deliveries_succeeded\": \"\",\n \"last_delivery_at\": \"\",\n \"last_success_at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"secret_prefix\": \"\",\n \"event_types\": [\n \"parcel.sold\",\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"disabled_at\": \"\",\n \"disabled_reason\": \"\",\n \"deliveries_attempted\": \"\",\n \"deliveries_succeeded\": \"\",\n \"last_delivery_at\": \"\",\n \"last_success_at\": \"\"\n }\n ],\n \"quota\": {\n \"maxEndpoints\": \"\",\n \"maxEventsPerDay\": \"\"\n },\n \"tier\": \"api_100k\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2c1c13c-8dc8-44f9-884e-04930238a9bd", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ef0e268-14c7-4f26-9c20-510b1f9b2fc2", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f64faacd-c0c4-48bb-8aea-d8e6b7d19d87", "name": "Create a webhook endpoint", "request": { "name": "Create a webhook endpoint", "description": { "content": "Creates a new webhook subscription. The returned `secret` is shown ONCE — store it server-side and use it to verify every incoming delivery via the `X-PropRaven-Signature` header (HMAC-SHA256 over `.`). Reject deliveries where `|now - t| > 5min`.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3a514eba-050a-48e1-a2fd-aee338aed368", "name": "Webhook created. Response includes the one-time secret.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"secret\": \"\",\n \"hint\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"secret_prefix\": \"\",\n \"event_types\": [\n \"parcel.sold\",\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"disabled_at\": \"\",\n \"disabled_reason\": \"\",\n \"deliveries_attempted\": \"\",\n \"deliveries_succeeded\": \"\",\n \"last_delivery_at\": \"\",\n \"last_success_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b4bbcb4-ecf7-4e3c-89f4-29f0feecb0b5", "name": "Invalid url, event_types, filter_kind, or filter_value.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f15b54d-38d7-4e1c-a0b3-55c60f55dc90", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8313b157-8211-409e-9072-b6184ae0ae1d", "name": "Tier quota reached or feature gated. Body includes upgrade guidance.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdcae247-db94-4922-8b96-fc4941b78bc5", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45ee015a-9e31-43f1-8d60-36e1665a623a", "name": "One or more event types are accepted by the API but not yet emitted by the scanner. Only `parcel.sold` is live in v1.0.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"parcel.owner_changed\"\n ],\n \"filter_kind\": \"county_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "abe13c53-dae9-42f4-9d3d-1969c9208bc8", "name": "Get a single webhook endpoint", "request": { "name": "Get a single webhook endpoint", "description": { "content": "Returns the full endpoint record (without the secret).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ec9386d-2922-4638-ba91-860cb03c8131", "name": "Webhook endpoint returned.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"secret_prefix\": \"\",\n \"event_types\": [\n \"parcel.sold\",\n \"parcel.permit_filed\"\n ],\n \"filter_kind\": \"state_fips\",\n \"filter_value\": {\n \"parcel_ids\": [\n \"\"\n ]\n },\n \"description\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"disabled_at\": \"\",\n \"disabled_reason\": \"\",\n \"deliveries_attempted\": \"\",\n \"deliveries_succeeded\": \"\",\n \"last_delivery_at\": \"\",\n \"last_success_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a60317-d4be-4465-8748-9199153cbef0", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "223d6202-fcda-4601-86db-392f2ab94b77", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9166cfaf-0252-49d1-98ad-34d0b70fc18f", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3925424-4b29-4a77-b0bc-35e7004debed", "name": "Soft-disable a webhook endpoint", "request": { "name": "Soft-disable a webhook endpoint", "description": { "content": "Marks the endpoint inactive. Delivery history is preserved. The endpoint can no longer receive new events but past deliveries remain queryable via the deliveries route.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be8dd9dd-bc5a-431f-8f50-6f456a01e358", "name": "Webhook disabled.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17f16d1b-33c2-4208-841b-eaec29f91036", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2bc88ce-6410-40c8-84ac-3d3398e59e36", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2353d499-838c-4db8-82a9-a7c51bc753bf", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "deliveries", "description": "", "item": [ { "id": "060e0a12-b5e1-423e-9b2f-45819ac1fb63", "name": "Recent delivery attempts for a webhook", "request": { "name": "Recent delivery attempts for a webhook", "description": { "content": "Returns the last 100 delivery attempts for an endpoint — useful for debugging signature mismatches, retry visibility, and dead-letter inspection.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f8ec0b1c-9835-43db-8ab2-b3fd0c714d21", "name": "Recent deliveries returned (max 100, newest first).", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"deliveries\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"parcel.owner_changed\",\n \"event_occurred_at\": \"\",\n \"status\": \"pending\",\n \"attempts\": \"\",\n \"last_attempt_at\": \"\",\n \"next_attempt_at\": \"\",\n \"last_response_status\": \"\",\n \"last_response_body\": \"\",\n \"last_error\": \"\",\n \"dead_lettered_at\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"parcel.owner_changed\",\n \"event_occurred_at\": \"\",\n \"status\": \"in_flight\",\n \"attempts\": \"\",\n \"last_attempt_at\": \"\",\n \"next_attempt_at\": \"\",\n \"last_response_status\": \"\",\n \"last_response_body\": \"\",\n \"last_error\": \"\",\n \"dead_lettered_at\": \"\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c88d607c-d71b-484a-8f28-71afd56cd3a7", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e7685b2-2dad-4253-9821-c0485228c383", "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb70dbe4-a61f-4b0c-b660-e8cd2f89f81a", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook endpoint ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "account", "description": "", "item": [ { "name": "usage", "description": "", "item": [ { "id": "9a17bb23-25d9-4718-9107-47005f34183d", "name": "Current-period usage and quota", "request": { "name": "Current-period usage and quota", "description": { "content": "Returns the calling key's current-period API usage, included allotment, remaining calls, configured per-minute and per-day rate limits, and the hard-cap status. Per-user (all of a user's API keys roll up to the same monthly counter, since they share a Stripe subscription).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "account", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0325f373-bf5b-4da3-a601-f80a9b92af7a", "name": "Usage report.", "originalRequest": { "url": { "path": [ "api", "v1", "account", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"tier\": \"api_100k\",\n \"period\": {\n \"start\": \"\",\n \"end\": \"\",\n \"label\": \"\"\n },\n \"calls_included\": \"\",\n \"calls_used\": \"\",\n \"calls_remaining\": \"\",\n \"hard_capped\": \"\",\n \"rate_limit\": {\n \"per_minute\": \"\",\n \"per_day\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d814620e-eaf9-40aa-9711-7e4eb697c764", "name": "Invalid or missing API key.", "originalRequest": { "url": { "path": [ "api", "v1", "account", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "555ae901-accb-419c-93a1-3ea6f07d818a", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "account", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.propraven.com" } ], "info": { "_postman_id": "533669f9-d8b4-494c-93b3-5dd397a2e6a6", "name": "PropRaven API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "National property intelligence API providing access to 180M+ US parcels with ownership, valuation, permit, deed, risk, and market data.\n\nContact Support:\n Name: PropRaven Support\n Email: support@propraven.com", "type": "text/plain" } } }