{ "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "signup", "description": "", "item": [ { "id": "658c57cc-ab66-4825-8476-7db539e828f0", "name": "Start free tier signup. Sends a 6-digit verification code to the email.", "request": { "name": "Start free tier signup. Sends a 6-digit verification code to the email.", "description": { "content": "Start free tier signup. Sends a 6-digit verification code to the email.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"UZB@A0kT1A7.FUr.YEHgZ0.ESPLOpcN5bS.ScglWFXp.PY5Qt.uEmLHUiaJ\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8925494d-4344-425f-b844-1f10658abfbb", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"UZB@A0kT1A7.FUr.YEHgZ0.ESPLOpcN5bS.ScglWFXp.PY5Qt.uEmLHUiaJ\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"message\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93194b17-b3fc-41b2-9865-a8c163c6c45c", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"UZB@A0kT1A7.FUr.YEHgZ0.ESPLOpcN5bS.ScglWFXp.PY5Qt.uEmLHUiaJ\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c0ae88-0d81-467d-8d6b-50f1dbc1da21", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"UZB@A0kT1A7.FUr.YEHgZ0.ESPLOpcN5bS.ScglWFXp.PY5Qt.uEmLHUiaJ\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "verify", "description": "", "item": [ { "id": "808bbf02-6870-47a1-bfbb-8c6f4d8421d9", "name": "Complete free tier signup by verifying email code. Returns API key (shown once).", "request": { "name": "Complete free tier signup by verifying email code. Returns API key (shown once).", "description": { "content": "Complete free tier signup by verifying email code. Returns API key (shown once).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "signup", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"OHlus@MjzSUcYXJV.U2kBF.NJI0jQV.KT1XY.Dz9kikfw29.Iwa.WjNSzRtHe.4TLdl2Ea1UY.Pwuqr9.NCenoJZbo\",\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "822543fe-5602-4878-acc7-27af0bfe46f6", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "signup", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"OHlus@MjzSUcYXJV.U2kBF.NJI0jQV.KT1XY.Dz9kikfw29.Iwa.WjNSzRtHe.4TLdl2Ea1UY.Pwuqr9.NCenoJZbo\",\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"apiKey\": \"\",\n \"email\": \"\",\n \"tier\": \"\",\n \"message\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dd28f95-0d70-463c-aaa2-2251c2d19372", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "signup", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"OHlus@MjzSUcYXJV.U2kBF.NJI0jQV.KT1XY.Dz9kikfw29.Iwa.WjNSzRtHe.4TLdl2Ea1UY.Pwuqr9.NCenoJZbo\",\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "checkout", "description": "", "item": [ { "name": "create", "description": "", "item": [ { "id": "c88c3881-05ef-487b-a27b-353e8a63a87a", "name": "Create a Stripe Checkout Session for subscription signup", "request": { "name": "Create a Stripe Checkout Session for subscription signup", "description": { "content": "Create a Stripe Checkout Session for subscription signup", "type": "text/plain" }, "url": { "path": [ "api", "v1", "checkout", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"j1pVI@ed.kNCYmXiaeB.vHj.q8mXat.gOuIKfHV1rp.y4yigKjXh4N.CzJpvPtrCap\",\n \"tier\": \"starter\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c4ebdb4b-0697-4573-9d4d-6bdaa656c8f4", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "checkout", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"j1pVI@ed.kNCYmXiaeB.vHj.q8mXat.gOuIKfHV1rp.y4yigKjXh4N.CzJpvPtrCap\",\n \"tier\": \"starter\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"url\": \"\",\n \"sessionId\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d4b3075-05c8-4e81-9983-dbfd55d48a71", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "checkout", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"j1pVI@ed.kNCYmXiaeB.vHj.q8mXat.gOuIKfHV1rp.y4yigKjXh4N.CzJpvPtrCap\",\n \"tier\": \"starter\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f41d8a-3d2d-47c4-a12b-81b20e299dbb", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "checkout", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"j1pVI@ed.kNCYmXiaeB.vHj.q8mXat.gOuIKfHV1rp.y4yigKjXh4N.CzJpvPtrCap\",\n \"tier\": \"starter\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "success", "description": "", "item": [ { "id": "4a1ff773-5006-495c-82fd-3f6d7a903695", "name": "Retrieve API key after successful checkout", "request": { "name": "Retrieve API key after successful checkout", "description": { "content": "Retrieve API key after successful checkout", "type": "text/plain" }, "url": { "path": [ "api", "v1", "checkout", "success" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "session_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "J@sa.gKp9k.tyf.IsU8C.2SEjvWa3JEz.L2OwYsbCSR.kmg" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9bfbddaf-4ded-4541-814e-60e95e391b96", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "checkout", "success" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "session_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "J@sa.gKp9k.tyf.IsU8C.2SEjvWa3JEz.L2OwYsbCSR.kmg" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"apiKey\": \"\",\n \"email\": \"\",\n \"tier\": \"\",\n \"message\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "billing", "description": "", "item": [ { "name": "portal", "description": "", "item": [ { "id": "6d762ad9-c8e1-433d-814f-ad355a8d445e", "name": "Create a Stripe Customer Portal session", "request": { "name": "Create a Stripe Customer Portal session", "description": { "content": "Create a Stripe Customer Portal session", "type": "text/plain" }, "url": { "path": [ "api", "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "222c41d4-448a-4de8-b83c-48f451bed2f4", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"url\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3972fb31-b18b-4930-8c13-1c53cc63956d", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df3e3c37-d682-48c7-9c6c-dba3d3f2656a", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "account", "description": "", "item": [ { "id": "eb196487-bd39-42f7-98ba-75e74d595522", "name": "Get your account information including tier and rate limits", "request": { "name": "Get your account information including tier and rate limits", "description": { "content": "Get your account information including tier and rate limits", "type": "text/plain" }, "url": { "path": [ "api", "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d15bab92-ff19-4239-8f96-c737d204d982", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"email\": \"\",\n \"tier\": \"\",\n \"tierName\": \"\",\n \"subscriptionStatus\": \"\",\n \"trialEndsAt\": \"\",\n \"apiKeyPrefix\": \"\",\n \"rateLimitPerMinute\": \"\",\n \"rateLimitPerMonth\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "524fc56d-2353-4d43-9812-57b01670a964", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "usage", "description": "", "item": [ { "id": "2fe99b03-cade-4c2c-b4c7-7e90df88c7c4", "name": "Get your current month API usage statistics", "request": { "name": "Get your current month API usage statistics", "description": { "content": "Get your current month API usage statistics", "type": "text/plain" }, "url": { "path": [ "api", "v1", "account", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "aa982de9-e1af-45ae-99ab-ca879d2e8bf1", "name": "Default Response", "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"tier\": \"\",\n \"rateLimitPerMinute\": \"\",\n \"rateLimitPerMonth\": \"\",\n \"currentMonthUsage\": \"\",\n \"currentMonthRemaining\": \"\",\n \"billingPeriod\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50fa9c37-6b6b-4344-b6e5-4f9fcba333a1", "name": "Default Response", "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "keys", "description": "", "item": [ { "id": "540f1664-8ced-4e60-bf2d-d4551433fba8", "name": "List your API keys (prefix only — full key is never stored)", "request": { "name": "List your API keys (prefix only — full key is never stored)", "description": { "content": "List your API keys (prefix only — full key is never stored)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "account", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "90c5ed11-f253-4705-bc1b-4cded2fbabe9", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"keys\": [\n {\n \"id\": \"\",\n \"keyPrefix\": \"\",\n \"name\": \"\",\n \"isActive\": \"\",\n \"lastUsedAt\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"keyPrefix\": \"\",\n \"name\": \"\",\n \"isActive\": \"\",\n \"lastUsedAt\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"maxKeys\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef7e4b2-56c1-49d7-bdcc-eafaa68e418c", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ca0ffce-b77b-483e-b0a8-dc0a182819cc", "name": "Generate a new API key (returns raw key once — store it securely)", "request": { "name": "Generate a new API key (returns raw key once — store it securely)", "description": { "content": "Generate a new API key (returns raw key once — store it securely)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "account", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4dec0407-ee3e-42cd-907b-07c23857fdc7", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys" ], "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"apiKey\": \"\",\n \"keyPrefix\": \"\",\n \"name\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6c2f283-087e-41de-acb4-076c45e09256", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys" ], "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2232938a-8098-435c-a3fd-576d6ae06fb5", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys" ], "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{keyId}", "description": "", "item": [ { "id": "ec0ecb4d-7b81-4dfe-b2fd-ce98cb9bf971", "name": "Revoke an API key", "request": { "name": "Revoke an API key", "description": { "content": "Revoke an API key", "type": "text/plain" }, "url": { "path": [ "api", "v1", "account", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "67794671-724d-4c9f-a89e-1c078a349a6c", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"message\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "623a0a8b-abb5-441a-9636-c0db7fddc348", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f52df2-157c-409a-8b07-b3f57f9c310e", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e7e7995-8e89-4450-83f5-45924057818f", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "account", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "properties", "description": "", "item": [ { "id": "92b3e255-69b6-4386-aa6a-10de2402ac00", "name": "Search properties with filters. Returns paginated results tier-gated by your subscription.", "request": { "name": "Search properties with filters. Returns paginated results tier-gated by your subscription.", "description": { "content": "Search properties with filters. Returns paginated results tier-gated by your subscription.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "state", "value": "AR" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "zip", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of single_family,condo,townhouse,multi_family,land,manufactured,apartment,other)", "type": "text/plain" }, "key": "property_type", "value": "manufactured" }, { "disabled": false, "description": { "content": " (This can only be one of for_sale,pending,sold,for_rent,off_market,coming_soon)", "type": "text/plain" }, "key": "listing_status", "value": "for_sale" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_year_built", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of high,medium,low,single_source)", "type": "text/plain" }, "key": "confidence", "value": "low" }, { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b221d92b-0678-4039-8649-0a6fbe214ff9", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "state", "value": "AR" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "zip", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of single_family,condo,townhouse,multi_family,land,manufactured,apartment,other)", "type": "text/plain" }, "key": "property_type", "value": "manufactured" }, { "disabled": false, "description": { "content": " (This can only be one of for_sale,pending,sold,for_rent,off_market,coming_soon)", "type": "text/plain" }, "key": "listing_status", "value": "for_sale" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_year_built", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of high,medium,low,single_source)", "type": "text/plain" }, "key": "confidence", "value": "low" }, { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"properties\": [\n {\n \"id\": \"6bcbFE2A-EFB1-5A3B-956d-1baacAD8386D\",\n \"address\": {\n \"street\": \"\",\n \"unit\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"coordinates\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"price\": {\n \"listing\": \"\",\n \"sold\": \"\",\n \"per_sqft\": \"\"\n },\n \"details\": {\n \"beds\": \"\",\n \"baths\": \"\",\n \"sqft\": \"\",\n \"lot_sqft\": \"\",\n \"year_built\": \"\",\n \"property_type\": \"\",\n \"stories\": \"\",\n \"garage\": \"\",\n \"hoa_monthly\": \"\"\n },\n \"listing\": {\n \"status\": \"\",\n \"days_on_market\": \"\",\n \"date_listed\": \"\",\n \"date_sold\": \"\",\n \"mls_id\": \"\"\n },\n \"description\": \"\",\n \"geographic_ids\": {\n \"census_tract\": \"\",\n \"fips_code\": \"\",\n \"cbsa_code\": \"\",\n \"placekey\": \"\"\n },\n \"data_summary\": {\n \"overall_confidence\": \"\",\n \"source_count\": \"\",\n \"completeness_score\": \"\",\n \"source_tier\": \"\"\n },\n \"price_history\": \"\",\n \"tax_history\": \"\",\n \"tax_year_coverage\": \"\",\n \"government_data\": \"\",\n \"data_quality\": \"\",\n \"sources\": \"\",\n \"validation_warnings\": \"\",\n \"enrichment_failures\": \"\",\n \"raw_record\": \"\"\n },\n {\n \"id\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"address\": {\n \"street\": \"\",\n \"unit\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"coordinates\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"price\": {\n \"listing\": \"\",\n \"sold\": \"\",\n \"per_sqft\": \"\"\n },\n \"details\": {\n \"beds\": \"\",\n \"baths\": \"\",\n \"sqft\": \"\",\n \"lot_sqft\": \"\",\n \"year_built\": \"\",\n \"property_type\": \"\",\n \"stories\": \"\",\n \"garage\": \"\",\n \"hoa_monthly\": \"\"\n },\n \"listing\": {\n \"status\": \"\",\n \"days_on_market\": \"\",\n \"date_listed\": \"\",\n \"date_sold\": \"\",\n \"mls_id\": \"\"\n },\n \"description\": \"\",\n \"geographic_ids\": {\n \"census_tract\": \"\",\n \"fips_code\": \"\",\n \"cbsa_code\": \"\",\n \"placekey\": \"\"\n },\n \"data_summary\": {\n \"overall_confidence\": \"\",\n \"source_count\": \"\",\n \"completeness_score\": \"\",\n \"source_tier\": \"\"\n },\n \"price_history\": \"\",\n \"tax_history\": \"\",\n \"tax_year_coverage\": \"\",\n \"government_data\": \"\",\n \"data_quality\": \"\",\n \"sources\": \"\",\n \"validation_warnings\": \"\",\n \"enrichment_failures\": \"\",\n \"raw_record\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c647289-be0a-448b-a338-f80e1d8c4cb8", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "state", "value": "AR" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "zip", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of single_family,condo,townhouse,multi_family,land,manufactured,apartment,other)", "type": "text/plain" }, "key": "property_type", "value": "manufactured" }, { "disabled": false, "description": { "content": " (This can only be one of for_sale,pending,sold,for_rent,off_market,coming_soon)", "type": "text/plain" }, "key": "listing_status", "value": "for_sale" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_year_built", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of high,medium,low,single_source)", "type": "text/plain" }, "key": "confidence", "value": "low" }, { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "34233ec0-d669-4db9-973d-da03178be549", "name": "Get full property detail by ID. Government data requires Pro tier.", "request": { "name": "Get full property detail by ID. Government data requires Pro tier.", "description": { "content": "Get full property detail by ID. Government data requires Pro tier.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" } ], "variable": [ { "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "90a4349a-baad-4f1f-a416-ef64b7c52114", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"property\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"address\": {\n \"street\": \"\",\n \"unit\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"coordinates\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"price\": {\n \"listing\": \"\",\n \"sold\": \"\",\n \"per_sqft\": \"\"\n },\n \"details\": {\n \"beds\": \"\",\n \"baths\": \"\",\n \"sqft\": \"\",\n \"lot_sqft\": \"\",\n \"year_built\": \"\",\n \"property_type\": \"\",\n \"stories\": \"\",\n \"garage\": \"\",\n \"hoa_monthly\": \"\"\n },\n \"listing\": {\n \"status\": \"\",\n \"days_on_market\": \"\",\n \"date_listed\": \"\",\n \"date_sold\": \"\",\n \"mls_id\": \"\"\n },\n \"description\": \"\",\n \"geographic_ids\": {\n \"census_tract\": \"\",\n \"fips_code\": \"\",\n \"cbsa_code\": \"\",\n \"placekey\": \"\"\n },\n \"data_summary\": {\n \"overall_confidence\": \"\",\n \"source_count\": \"\",\n \"completeness_score\": \"\",\n \"source_tier\": \"\"\n },\n \"price_history\": \"\",\n \"tax_history\": \"\",\n \"tax_year_coverage\": \"\",\n \"government_data\": \"\",\n \"data_quality\": \"\",\n \"sources\": \"\",\n \"validation_warnings\": \"\",\n \"enrichment_failures\": \"\",\n \"raw_record\": \"\"\n }\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fdb04b4-80f2-4ccc-b0ff-4df03ff855b1", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a6ac778-6d0d-4789-9da0-e36306c48bbd", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "enrichment", "description": "", "item": [ { "id": "03309c59-f33e-435e-9e8e-2053ee227769", "name": "Get government enrichment data for a property. Requires Pro or Enterprise tier.", "request": { "name": "Get government enrichment data for a property. Requires Pro or Enterprise tier.", "description": { "content": "Get government enrichment data for a property. Requires Pro or Enterprise tier.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "properties", ":id", "enrichment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e5e6013f-9dad-40fa-8791-0a2cc03ec67f", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id", "enrichment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"government_data\": \"\",\n \"census_tract\": \"\",\n \"fips_code\": \"\",\n \"cbsa_code\": \"\",\n \"placekey\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03a939b7-947c-4524-802a-d8e898a59729", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id", "enrichment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dca46c88-908a-4d1f-8f42-9b568532ede3", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id", "enrichment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10998eeb-95dd-4983-a834-baa0931bb870", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "properties", ":id", "enrichment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "search", "description": "", "item": [ { "id": "7caedc67-1d78-49d7-9d1f-bc6974d14acf", "name": "Full-text search across property addresses and descriptions.", "request": { "name": "Full-text search across property addresses and descriptions.", "description": { "content": "Full-text search across property addresses and descriptions.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "state", "value": "AR" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "zip", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of single_family,condo,townhouse,multi_family,land,manufactured,apartment,other)", "type": "text/plain" }, "key": "property_type", "value": "manufactured" }, { "disabled": false, "description": { "content": " (This can only be one of for_sale,pending,sold,for_rent,off_market,coming_soon)", "type": "text/plain" }, "key": "listing_status", "value": "for_sale" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_year_built", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of high,medium,low,single_source)", "type": "text/plain" }, "key": "confidence", "value": "low" }, { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "240a3696-c905-4a02-ba61-165a4f4f891d", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "state", "value": "AR" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "zip", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of single_family,condo,townhouse,multi_family,land,manufactured,apartment,other)", "type": "text/plain" }, "key": "property_type", "value": "manufactured" }, { "disabled": false, "description": { "content": " (This can only be one of for_sale,pending,sold,for_rent,off_market,coming_soon)", "type": "text/plain" }, "key": "listing_status", "value": "for_sale" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_year_built", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of high,medium,low,single_source)", "type": "text/plain" }, "key": "confidence", "value": "low" }, { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"properties\": [\n {\n \"id\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"address\": {\n \"street\": \"\",\n \"unit\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"coordinates\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"price\": {\n \"listing\": \"\",\n \"sold\": \"\",\n \"per_sqft\": \"\"\n },\n \"details\": {\n \"beds\": \"\",\n \"baths\": \"\",\n \"sqft\": \"\",\n \"lot_sqft\": \"\",\n \"year_built\": \"\",\n \"property_type\": \"\",\n \"stories\": \"\",\n \"garage\": \"\",\n \"hoa_monthly\": \"\"\n },\n \"listing\": {\n \"status\": \"\",\n \"days_on_market\": \"\",\n \"date_listed\": \"\",\n \"date_sold\": \"\",\n \"mls_id\": \"\"\n },\n \"description\": \"\",\n \"geographic_ids\": {\n \"census_tract\": \"\",\n \"fips_code\": \"\",\n \"cbsa_code\": \"\",\n \"placekey\": \"\"\n },\n \"data_summary\": {\n \"overall_confidence\": \"\",\n \"source_count\": \"\",\n \"completeness_score\": \"\",\n \"source_tier\": \"\"\n },\n \"price_history\": \"\",\n \"tax_history\": \"\",\n \"tax_year_coverage\": \"\",\n \"government_data\": \"\",\n \"data_quality\": \"\",\n \"sources\": \"\",\n \"validation_warnings\": \"\",\n \"enrichment_failures\": \"\",\n \"raw_record\": \"\"\n },\n {\n \"id\": \"5a3FBbAD-Fd2B-6ed9-A0cE-ADa8B41220ca\",\n \"address\": {\n \"street\": \"\",\n \"unit\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"coordinates\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"price\": {\n \"listing\": \"\",\n \"sold\": \"\",\n \"per_sqft\": \"\"\n },\n \"details\": {\n \"beds\": \"\",\n \"baths\": \"\",\n \"sqft\": \"\",\n \"lot_sqft\": \"\",\n \"year_built\": \"\",\n \"property_type\": \"\",\n \"stories\": \"\",\n \"garage\": \"\",\n \"hoa_monthly\": \"\"\n },\n \"listing\": {\n \"status\": \"\",\n \"days_on_market\": \"\",\n \"date_listed\": \"\",\n \"date_sold\": \"\",\n \"mls_id\": \"\"\n },\n \"description\": \"\",\n \"geographic_ids\": {\n \"census_tract\": \"\",\n \"fips_code\": \"\",\n \"cbsa_code\": \"\",\n \"placekey\": \"\"\n },\n \"data_summary\": {\n \"overall_confidence\": \"\",\n \"source_count\": \"\",\n \"completeness_score\": \"\",\n \"source_tier\": \"\"\n },\n \"price_history\": \"\",\n \"tax_history\": \"\",\n \"tax_year_coverage\": \"\",\n \"government_data\": \"\",\n \"data_quality\": \"\",\n \"sources\": \"\",\n \"validation_warnings\": \"\",\n \"enrichment_failures\": \"\",\n \"raw_record\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"query\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a835b237-4365-4ab2-a278-961c3fc31a15", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "state", "value": "AR" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "city", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "zip", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of single_family,condo,townhouse,multi_family,land,manufactured,apartment,other)", "type": "text/plain" }, "key": "property_type", "value": "manufactured" }, { "disabled": false, "description": { "content": " (This can only be one of for_sale,pending,sold,for_rent,off_market,coming_soon)", "type": "text/plain" }, "key": "listing_status", "value": "for_sale" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_beds", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "max_sqft", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_year_built", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of high,medium,low,single_source)", "type": "text/plain" }, "key": "confidence", "value": "low" }, { "disabled": false, "description": { "content": " (This can only be one of json,csv,ndjson,geojson)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "exports", "description": "", "item": [ { "id": "9ee855d5-4171-4beb-b010-5042f2b72a88", "name": "Create a bulk export job. Enterprise tier required. Returns a job ID to poll.", "request": { "name": "Create a bulk export job. Enterprise tier required. Returns a job ID to poll.", "description": { "content": "Create a bulk export job. Enterprise tier required. Returns a job ID to poll.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"EU\",\n \"city\": \"\",\n \"zip\": \"\",\n \"property_type\": \"other\",\n \"listing_status\": \"for_rent\",\n \"min_price\": \"\",\n \"max_price\": \"\",\n \"min_beds\": \"\",\n \"max_beds\": \"\",\n \"min_sqft\": \"\",\n \"max_sqft\": \"\",\n \"min_year_built\": \"\",\n \"confidence\": \"low\",\n \"format\": \"json\",\n \"limit\": 10000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0bffa654-a243-4266-8dc0-1f7d175e00fb", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"EU\",\n \"city\": \"\",\n \"zip\": \"\",\n \"property_type\": \"other\",\n \"listing_status\": \"for_rent\",\n \"min_price\": \"\",\n \"max_price\": \"\",\n \"min_beds\": \"\",\n \"max_beds\": \"\",\n \"min_sqft\": \"\",\n \"max_sqft\": \"\",\n \"min_year_built\": \"\",\n \"confidence\": \"low\",\n \"format\": \"json\",\n \"limit\": 10000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"exportId\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"status\": \"\",\n \"format\": \"\",\n \"estimatedRows\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8f40501-c52d-447c-86bc-051c4d87ebc3", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"EU\",\n \"city\": \"\",\n \"zip\": \"\",\n \"property_type\": \"other\",\n \"listing_status\": \"for_rent\",\n \"min_price\": \"\",\n \"max_price\": \"\",\n \"min_beds\": \"\",\n \"max_beds\": \"\",\n \"min_sqft\": \"\",\n \"max_sqft\": \"\",\n \"min_year_built\": \"\",\n \"confidence\": \"low\",\n \"format\": \"json\",\n \"limit\": 10000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2509739-76fb-4996-8ef1-fc9f437d47f1", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "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: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"EU\",\n \"city\": \"\",\n \"zip\": \"\",\n \"property_type\": \"other\",\n \"listing_status\": \"for_rent\",\n \"min_price\": \"\",\n \"max_price\": \"\",\n \"min_beds\": \"\",\n \"max_beds\": \"\",\n \"min_sqft\": \"\",\n \"max_sqft\": \"\",\n \"min_year_built\": \"\",\n \"confidence\": \"low\",\n \"format\": \"json\",\n \"limit\": 10000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "003e0d19-9088-4631-820f-8f0b33986be7", "name": "Check export job status. When completed, use GET /exports/:id/download to retrieve the file.", "request": { "name": "Check export job status. When completed, use GET /exports/:id/download to retrieve the file.", "description": { "content": "Check export job status. When completed, use GET /exports/:id/download to retrieve the file.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5fa3fa31-79ca-4199-b8a1-6e556ba661ad", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"exportId\": \"\",\n \"status\": \"completed\",\n \"format\": \"\",\n \"rowCount\": \"\",\n \"createdAt\": \"\",\n \"downloadUrl\": \"\",\n \"error\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b72d7414-8628-42f3-8910-699fcd0853b6", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8ae01c9-0d5a-42d6-85e6-47baafc7bfb1", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "download", "description": "", "item": [ { "id": "e486262b-0265-47e6-8d41-8b45b71741ca", "name": "Download a completed export. Returns the file in the requested format.", "request": { "name": "Download a completed export. Returns the file in the requested format.", "description": { "content": "Download a completed export. Returns the file in the requested format.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8c8fd6a8-4c1e-4428-a934-18523b93aba0", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "admin", "description": "", "item": [ { "name": "customers", "description": "", "item": [ { "id": "fde8c623-d5b0-4ad6-98af-a75ebe7e068b", "name": "List all customers (admin only)", "request": { "name": "List all customers (admin only)", "description": { "content": "List all customers (admin only)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "admin", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": " (This can only be one of free,trial,starter,pro,enterprise)", "type": "text/plain" }, "key": "tier", "value": "trial" }, { "disabled": false, "description": { "content": " (This can only be one of trialing,active,past_due,canceled,incomplete,unpaid)", "type": "text/plain" }, "key": "status", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8cc75798-aa4e-487c-8b69-718e27bcbe7b", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": " (This can only be one of free,trial,starter,pro,enterprise)", "type": "text/plain" }, "key": "tier", "value": "trial" }, { "disabled": false, "description": { "content": " (This can only be one of trialing,active,past_due,canceled,incomplete,unpaid)", "type": "text/plain" }, "key": "status", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"customers\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"tier\": \"\",\n \"subscriptionStatus\": \"\",\n \"isAdmin\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"tier\": \"\",\n \"subscriptionStatus\": \"\",\n \"isAdmin\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f634d7-b327-4e8f-8249-34c863041d26", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": " (This can only be one of free,trial,starter,pro,enterprise)", "type": "text/plain" }, "key": "tier", "value": "trial" }, { "disabled": false, "description": { "content": " (This can only be one of trialing,active,past_due,canceled,incomplete,unpaid)", "type": "text/plain" }, "key": "status", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "76b6bb69-11d6-4097-98e5-403f6bb22d6a", "name": "Get customer detail with usage history (admin only)", "request": { "name": "Get customer detail with usage history (admin only)", "description": { "content": "Get customer detail with usage history (admin only)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "admin", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "69a5fbdd-3389-43cf-a9da-db834ecf98e1", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"tier\": \"\",\n \"tierName\": \"\",\n \"subscriptionStatus\": \"\",\n \"isAdmin\": \"\",\n \"stripeCustomerId\": \"\",\n \"createdAt\": \"\"\n },\n \"keys\": [\n {\n \"id\": \"\",\n \"keyPrefix\": \"\",\n \"name\": \"\",\n \"isActive\": \"\",\n \"lastUsedAt\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"keyPrefix\": \"\",\n \"name\": \"\",\n \"isActive\": \"\",\n \"lastUsedAt\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"usageHistory\": [\n {\n \"yearMonth\": \"\",\n \"propertiesConsumed\": \"\",\n \"requestsMade\": \"\"\n },\n {\n \"yearMonth\": \"\",\n \"propertiesConsumed\": \"\",\n \"requestsMade\": \"\"\n }\n ]\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa6c3cfe-ff9b-4bc4-a63a-37eaa9771273", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dba1f36e-f565-4a61-ad12-b43ce85d6ec4", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "metrics", "description": "", "item": [ { "id": "9ce029ba-2acd-4e3d-8207-2c5054131696", "name": "Get platform metrics (admin only)", "request": { "name": "Get platform metrics (admin only)", "description": { "content": "Get platform metrics (admin only)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "admin", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f02b2127-8963-4d68-bdf1-2dd17cda236b", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"totalCustomers\": \"\",\n \"activeCustomers\": \"\",\n \"customersByTier\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"mrr\": \"\",\n \"mrrFormatted\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad7da55e-4513-4fb8-8b7a-46f542eea9be", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "usage", "description": "", "item": [ { "id": "9391610e-4fca-4a4f-a434-1c5a0f867502", "name": "Get aggregated monthly usage report (admin only)", "request": { "name": "Get aggregated monthly usage report (admin only)", "description": { "content": "Get aggregated monthly usage report (admin only)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "admin", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "year_month", "value": "4827-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4db92cc2-1ff1-49ff-bcfb-fee2fee61a64", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "year_month", "value": "4827-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"yearMonth\": \"\",\n \"totalProperties\": \"\",\n \"totalRequests\": \"\",\n \"activeCustomers\": \"\"\n },\n \"meta\": {\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d7809f-8065-4e2f-b092-d99bca27b648", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1", "admin", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "year_month", "value": "4827-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "4b57f095-b7df-409a-a1f5-018d516e3948", "name": "/api/v1", "request": { "name": "/api/v1", "description": {}, "url": { "path": [ "api", "v1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "545d1ee5-40bd-4723-9bc3-fe2febcb1e5a", "name": "Default Response", "originalRequest": { "url": { "path": [ "api", "v1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "health", "description": "", "item": [ { "id": "edfa3032-b8fd-4267-9c83-bcdfb228712d", "name": "/health", "request": { "name": "/health", "description": {}, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d94669ab-46a8-46b5-8ad2-90d03a466999", "name": "Default Response", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.vitkidata.com" } ], "info": { "_postman_id": "ed8ad97c-952a-4946-ad1e-83ae92d147d2", "name": "Vitki Data Real Estate API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Enriched US real estate property data — search, filter, and access property listings with 48 government enrichment fields.\n\nContact Support:\n Name: Vitki Data\n Email: contact@vitkidata.com", "type": "text/plain" } } }