{ "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "jobs", "description": "", "item": [ { "name": "submit", "description": "", "item": [ { "id": "4259dc8b-17c5-4498-b25f-b3f428cff589", "name": "Submit Job", "request": { "name": "Submit Job", "description": { "content": "Submit a new scraping job to SpiderIQ distributed scraping platform\n\n## Supported Job Types\n\n### 1. SpiderMaps (`type: \"spiderMaps\"`)\nScrape business listings from maps services.\n\n- **Required**: Either `url` OR `search_query` in payload\n- **AI Usage**: None (0 tokens)\n- **Processing Time**: 30-90 seconds for 20 results\n- **Features**: Reviews, photos, multi-language support\n\n### 2. SpiderSite (`type: \"spiderSite\"`)\nIntelligent website crawling with AI-powered lead generation.\n\n- **Required**: `url` in payload\n- **AI Usage**: Opt-in (0 tokens by default, ~500-3,800 tokens if AI enabled)\n- **Processing Time**: 5-60 seconds depending on pages and AI features\n- **Features**:\n - v2.7.0: AI Context Engine (smart markdown compendiums + R2 storage)\n - v2.4.0: SPA auto-detection with Playwright\n - v2.3.0: Sitemap-first crawling\n - v2.2.1: AI opt-in defaults (zero cost unless enabled)\n - v2.1.0: Multilingual (36+ European languages)\n\n## SpiderIQ Features\n\n- **Automatic deduplication**: Returns cached job if submitted within 24 hours\n- **Distributed processing**: Jobs queued to RabbitMQ, processed by workers across multiple VPS servers\n- **Priority support**: 0-10 (higher number = processed first)\n- **Async processing**: Returns job ID immediately (<100ms), poll for results\n\n## Authentication\n\nRequires Bearer token: `Authorization: Bearer ::`\n\nContact admin to register a client and receive credentials.\n\n## Queue Limits\n\n- SpiderMaps queue: 10,000 jobs maximum\n- SpiderSite queue: 5,000 jobs maximum\n\n## Returns\n\nJob ID and initial status. Use `/jobs/{job_id}/status` to check progress.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"spiderMaps\",\n \"payload\": {},\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aad8d769-6432-476b-a9c9-08d60079e7d0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "submit" ], "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 \"type\": \"spiderMaps\",\n \"payload\": {},\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"message\": \"\",\n \"from_cache\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "088e8833-1fe5-460a-b1ca-2a78e0c216b0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "submit" ], "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 \"type\": \"spiderMaps\",\n \"payload\": {},\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "spiderMaps", "description": "", "item": [ { "name": "submit", "description": "", "item": [ { "id": "d3dfdbb2-85e7-4b70-bb53-292db2a819ee", "name": "Submit Spider Maps Job", "request": { "name": "Submit Spider Maps Job", "description": { "content": "Submit a SpiderMaps business scraping job\n\n## Overview\nScrape business listings from maps services with contact information, reviews, and photos.\n\n## Features\n- **Zero AI tokens used** - Pure web scraping, no LLM costs\n- **Processing time**: 30-90 seconds for 20 results\n- **Multi-language support**: Search in 50+ languages (en, es, fr, de, it, pt, etc.)\n- **Extract reviews**: Optional customer review scraping\n- **Extract photos**: Optional photo URL extraction\n- **Headless mode**: Runs in background without browser UI\n\n## Required Parameters\nEither `url` OR `search_query` must be provided in the payload:\n- `url`: Direct Google Maps URL (e.g., https://www.google.com/maps/place/...)\n- `search_query`: Search query (e.g., \"italian restaurants in Boston\")\n\n## Authentication\nRequires Bearer token: `Authorization: Bearer ::`\n\n## Queue Limits\nGoogle Maps queue: 10,000 jobs maximum\n\n## Returns\nJob ID and initial status. Use `/jobs/{job_id}/status` to check progress.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7f5f7b2-5ab8-4cf2-99cf-7a78f26ce281", "name": "Job created and queued successfully", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"message\": \"\",\n \"from_cache\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "618daefd-773c-4c45-be4d-3aec0ab61d32", "name": "Authentication failed", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd17b4a6-a668-4b37-840c-234d13252d21", "name": "Client account is inactive", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "349cfb70-70a9-44e5-9a2a-d6b62d30a160", "name": "Validation error - Invalid payload", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38f246d8-a5c8-46ee-839a-a04bade17aaf", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 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": "Maximum requests allowed per minute", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "Requests remaining in current window", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Unix timestamp when rate limit resets", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c5f35f1-20c5-438d-8445-1e105a5d3d3d", "name": "Database error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dae05627-137d-4d40-b072-e823fa1efa98", "name": "Queue service unavailable", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"search_query\": \"\",\n \"max_results\": 10,\n \"extract_reviews\": false,\n \"extract_photos\": false,\n \"lang\": \"en\",\n \"headless\": true,\n \"test\": false,\n \"store_images\": true,\n \"validate_phones\": true\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "campaigns", "description": "", "item": [ { "name": "submit", "description": "", "item": [ { "id": "2d133617-2b08-4c8c-988c-b61dc68714f3", "name": "Create a new SpiderMaps campaign", "request": { "name": "Create a new SpiderMaps campaign", "description": { "content": "Create a new SpiderMaps scraping campaign for a specific country and query.\n\n **What happens:**\n 1. Campaign is created with specified filters\n 2. Matching locations are pre-computed and stored\n 3. Campaign is ready for `/next` calls\n\n **Filter Modes:**\n - `all` - All locations in the country (default)\n - `population` - Filter by min/max population\n - `cities_only` - Only cities, no postcodes\n - `custom` - Specific location_ids\n - `regions` - Specific admin regions\n\n **Example - Scrape restaurants in France:**\n ```json\n {\n \"query\": \"restaurants\",\n \"country_code\": \"FR\",\n \"name\": \"France Restaurants 2024\",\n \"filter\": {\n \"mode\": \"population\",\n \"min_population\": 50000\n }\n }\n ```\n\n **Returns:**\n - `campaign_id` - Use this for subsequent calls\n - `total_locations` - Number of locations to scrape\n - `next_location_id` - First location to be processed", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"country_code\": \"\",\n \"name\": \"\",\n \"filter\": {\n \"mode\": \"all\",\n \"min_population\": \"\",\n \"max_population\": \"\",\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"admin_regions\": [\n \"\",\n \"\"\n ],\n \"include_postcodes\": true\n },\n \"workflow\": {\n \"spidersite\": {\n \"enabled\": false,\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"compendium\": {\n \"enabled\": true,\n \"cleanup_level\": \"fit\",\n \"max_chars\": 100000,\n \"include_in_response\": true,\n \"remove_duplicates\": true\n },\n \"timeout\": 30\n },\n \"spiderverify\": {\n \"enabled\": false,\n \"check_gravatar\": false,\n \"check_dnsbl\": false,\n \"smtp_timeout_secs\": 45,\n \"max_emails_per_business\": 10\n },\n \"filter_social_media\": true,\n \"filter_review_sites\": true,\n \"filter_directories\": true,\n \"filter_maps\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "770c93a3-448b-4a4b-9f74-baaa9deb2680", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", "submit" ], "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 \"query\": \"\",\n \"country_code\": \"\",\n \"name\": \"\",\n \"filter\": {\n \"mode\": \"all\",\n \"min_population\": \"\",\n \"max_population\": \"\",\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"admin_regions\": [\n \"\",\n \"\"\n ],\n \"include_postcodes\": true\n },\n \"workflow\": {\n \"spidersite\": {\n \"enabled\": false,\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"compendium\": {\n \"enabled\": true,\n \"cleanup_level\": \"fit\",\n \"max_chars\": 100000,\n \"include_in_response\": true,\n \"remove_duplicates\": true\n },\n \"timeout\": 30\n },\n \"spiderverify\": {\n \"enabled\": false,\n \"check_gravatar\": false,\n \"check_dnsbl\": false,\n \"smtp_timeout_secs\": 45,\n \"max_emails_per_business\": 10\n },\n \"filter_social_media\": true,\n \"filter_review_sites\": true,\n \"filter_directories\": true,\n \"filter_maps\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"query\": \"\",\n \"country_code\": \"\",\n \"total_locations\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"last_location_id\": \"\",\n \"next_location_id\": \"\",\n \"has_workflow\": false,\n \"workflow_config\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "786c2128-9626-4ee4-bc01-840ec6b09ef5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", "submit" ], "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 \"query\": \"\",\n \"country_code\": \"\",\n \"name\": \"\",\n \"filter\": {\n \"mode\": \"all\",\n \"min_population\": \"\",\n \"max_population\": \"\",\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"admin_regions\": [\n \"\",\n \"\"\n ],\n \"include_postcodes\": true\n },\n \"workflow\": {\n \"spidersite\": {\n \"enabled\": false,\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"compendium\": {\n \"enabled\": true,\n \"cleanup_level\": \"fit\",\n \"max_chars\": 100000,\n \"include_in_response\": true,\n \"remove_duplicates\": true\n },\n \"timeout\": 30\n },\n \"spiderverify\": {\n \"enabled\": false,\n \"check_gravatar\": false,\n \"check_dnsbl\": false,\n \"smtp_timeout_secs\": 45,\n \"max_emails_per_business\": 10\n },\n \"filter_social_media\": true,\n \"filter_review_sites\": true,\n \"filter_directories\": true,\n \"filter_maps\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{campaign_id}", "description": "", "item": [ { "name": "next", "description": "", "item": [ { "id": "4fbceb50-a342-49be-a5c5-ca612d81b7ae", "name": "Get next location and submit job", "request": { "name": "Get next location and submit job", "description": { "content": "Get the next location for a campaign and automatically submit a SpiderMaps job.\n\n **What happens:**\n 1. Finds the next pending location in the campaign\n 2. Submits a SpiderMaps job for that location\n 3. Updates campaign progress\n 4. Returns job details and progress\n\n **N8N/Xano Workflow:**\n ```\n Loop while has_more == true:\n POST /campaigns/{id}/next\n # Wait for job to complete (optional)\n # Process results\n ```\n\n **Response Fields:**\n - `has_more` - true if more locations remain\n - `current_task` - Details of the submitted job\n - `progress` - Campaign progress statistics\n\n **When `has_more` is false:**\n - Campaign is complete\n - No more locations to process", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "next" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5c7a9e4f-1bec-4080-a361-68c01d75b414", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "next" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"has_more\": \"\",\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"progress\": {\n \"completed\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"total\": 0,\n \"percentage\": 0\n },\n \"current_task\": {\n \"job_id\": \"\",\n \"location_id\": \"\",\n \"search_string\": \"\",\n \"location_type\": \"\",\n \"status\": \"\",\n \"display_name\": \"\"\n },\n \"last_location_id\": \"\",\n \"next_location_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba0de375-695d-44b9-a6e3-e07f5f2bc75b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "next" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "status", "description": "", "item": [ { "id": "4f05b7f8-51c0-4347-88b1-bceb535d8b78", "name": "Get campaign status", "request": { "name": "Get campaign status", "description": { "content": "Get detailed status and statistics for a campaign.\n\n **Returns:**\n - Campaign configuration (query, country, filters)\n - Progress statistics (completed, failed, pending)\n - Job statistics by status (queued, processing, completed, failed)\n - Total businesses found", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0a67fcf0-65da-4a06-b24c-d03f1528c1d0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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" } ], "body": "{\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"query\": \"\",\n \"country_code\": \"\",\n \"filter_config\": {},\n \"progress\": {\n \"completed\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"total\": 0,\n \"percentage\": 0\n },\n \"jobs\": {\n \"queued\": 0,\n \"processing\": 0,\n \"completed\": 0,\n \"failed\": 0\n },\n \"results\": {\n \"total_businesses\": 0\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"last_location_id\": \"\",\n \"next_location_id\": \"\",\n \"has_workflow\": false,\n \"workflow_config\": {},\n \"workflow_progress\": {\n \"businesses_total\": 0,\n \"sites_queued\": 0,\n \"sites_completed\": 0,\n \"sites_failed\": 0,\n \"verifies_queued\": 0,\n \"verifies_completed\": 0,\n \"verifies_failed\": 0,\n \"emails_found\": 0,\n \"emails_verified\": 0\n },\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a48fa2eb-7893-48e9-8966-1552e1a8a076", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "stop", "description": "", "item": [ { "id": "a492e164-b6ea-4ae8-9e59-36d2298c9a16", "name": "Stop a campaign", "request": { "name": "Stop a campaign", "description": { "content": "Stop an active campaign.\n\n Stopped campaigns can be resumed later with `/continue`.\n Jobs already submitted will continue processing.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "17a4ec7f-2a7f-4354-b13b-868d31712ed5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"remaining_locations\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "289a8325-6c85-4dc2-af37-231d2cf114b3", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "continue", "description": "", "item": [ { "id": "6ed4a537-eda0-4a42-8b39-b2836e2cd859", "name": "Continue a stopped campaign", "request": { "name": "Continue a stopped campaign", "description": { "content": "Resume a stopped or paused campaign.\n\n Campaign will continue from where it left off.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "continue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "06a97405-f586-4882-bb18-c2fe68fa3e0d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "continue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"remaining_locations\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49ed39f6-1334-4f8e-a407-569a978711ad", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "continue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "workflow-results", "description": "", "item": [ { "id": "aee5a2e1-c717-4ba1-9536-29f437233d13", "name": "Get aggregated workflow results", "request": { "name": "Get aggregated workflow results", "description": { "content": "Get complete aggregated results from the workflow chain:\n SpiderMaps → SpiderSite → SpiderVerify\n\n **Returns data from all three services combined:**\n - SpiderMaps: Business listings (name, address, phone, rating)\n - SpiderSite: Website data (emails, social media, company info)\n - SpiderVerify: Email verification results (validity, score)\n\n **Note:** Only available for campaigns created with workflow configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "workflow-results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Include businesses that were filtered out", "type": "text/plain" }, "key": "include_filtered", "value": "false" } ], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6c99aaaa-a6e2-4374-aa5e-b9f87ecab113", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "workflow-results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Include businesses that were filtered out", "type": "text/plain" }, "key": "include_filtered", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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" } ], "body": "{\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"query\": \"\",\n \"country_code\": \"\",\n \"progress\": {\n \"completed\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"total\": 0,\n \"percentage\": 0\n },\n \"workflow_progress\": {\n \"businesses_total\": 0,\n \"sites_queued\": 0,\n \"sites_completed\": 0,\n \"sites_failed\": 0,\n \"verifies_queued\": 0,\n \"verifies_completed\": 0,\n \"verifies_failed\": 0,\n \"emails_found\": 0,\n \"emails_verified\": 0\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"total_locations\": 0,\n \"total_businesses\": 0,\n \"total_with_domains\": 0,\n \"total_domains_filtered\": 0,\n \"total_emails_found\": 0,\n \"total_emails_verified\": 0,\n \"total_valid_emails\": 0,\n \"locations\": [\n {\n \"location_id\": \"\",\n \"search_string\": \"\",\n \"status\": \"\",\n \"display_name\": \"\",\n \"businesses_count\": 0,\n \"businesses\": [\n {\n \"business_name\": \"\",\n \"business_place_id\": \"\",\n \"business_address\": \"\",\n \"business_phone\": \"\",\n \"business_rating\": \"\",\n \"business_reviews_count\": \"\",\n \"business_categories\": [\n \"\",\n \"\"\n ],\n \"gmaps_images\": [\n \"\",\n \"\"\n ],\n \"gmaps_image_url\": \"\",\n \"gmaps_description\": \"\",\n \"gmaps_amenities\": [\n \"\",\n \"\"\n ],\n \"gmaps_coordinates\": {\n \"key_0\": \"\"\n },\n \"google_place_id\": \"\",\n \"gmaps_link\": \"\",\n \"gmaps_phone_e164\": \"\",\n \"gmaps_phone_type\": \"\",\n \"gmaps_phone_valid\": \"\",\n \"original_website\": \"\",\n \"domain\": \"\",\n \"domain_filtered\": false,\n \"filter_reason\": \"\",\n \"spidersite_status\": \"\",\n \"spidersite_error\": \"\",\n \"pages_crawled\": \"\",\n \"emails_found\": [\n \"\",\n \"\"\n ],\n \"phones_found\": [\n \"\",\n \"\"\n ],\n \"social_media\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"company_info\": {},\n \"lead_scoring\": {},\n \"logo\": \"\",\n \"compendium\": \"\",\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"logo_metadata\": {},\n \"compendium_metadata\": {},\n \"metadata\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"crawl_status\": \"\",\n \"spiderverify_status\": \"\",\n \"spiderverify_error\": \"\",\n \"emails_verified\": [\n {\n \"email\": \"\",\n \"status\": \"valid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n },\n {\n \"email\": \"\",\n \"status\": \"risky\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n }\n ],\n \"valid_emails_count\": 0,\n \"workflow_stage\": \"maps\"\n },\n {\n \"business_name\": \"\",\n \"business_place_id\": \"\",\n \"business_address\": \"\",\n \"business_phone\": \"\",\n \"business_rating\": \"\",\n \"business_reviews_count\": \"\",\n \"business_categories\": [\n \"\",\n \"\"\n ],\n \"gmaps_images\": [\n \"\",\n \"\"\n ],\n \"gmaps_image_url\": \"\",\n \"gmaps_description\": \"\",\n \"gmaps_amenities\": [\n \"\",\n \"\"\n ],\n \"gmaps_coordinates\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"google_place_id\": \"\",\n \"gmaps_link\": \"\",\n \"gmaps_phone_e164\": \"\",\n \"gmaps_phone_type\": \"\",\n \"gmaps_phone_valid\": \"\",\n \"original_website\": \"\",\n \"domain\": \"\",\n \"domain_filtered\": false,\n \"filter_reason\": \"\",\n \"spidersite_status\": \"\",\n \"spidersite_error\": \"\",\n \"pages_crawled\": \"\",\n \"emails_found\": [\n \"\",\n \"\"\n ],\n \"phones_found\": [\n \"\",\n \"\"\n ],\n \"social_media\": {\n \"key_0\": \"\"\n },\n \"company_info\": {},\n \"lead_scoring\": {},\n \"logo\": \"\",\n \"compendium\": \"\",\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"logo_metadata\": {},\n \"compendium_metadata\": {},\n \"metadata\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"crawl_status\": \"\",\n \"spiderverify_status\": \"\",\n \"spiderverify_error\": \"\",\n \"emails_verified\": [\n {\n \"email\": \"\",\n \"status\": \"unknown\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n },\n {\n \"email\": \"\",\n \"status\": \"invalid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n }\n ],\n \"valid_emails_count\": 0,\n \"workflow_stage\": \"maps\"\n }\n ]\n },\n {\n \"location_id\": \"\",\n \"search_string\": \"\",\n \"status\": \"\",\n \"display_name\": \"\",\n \"businesses_count\": 0,\n \"businesses\": [\n {\n \"business_name\": \"\",\n \"business_place_id\": \"\",\n \"business_address\": \"\",\n \"business_phone\": \"\",\n \"business_rating\": \"\",\n \"business_reviews_count\": \"\",\n \"business_categories\": [\n \"\",\n \"\"\n ],\n \"gmaps_images\": [\n \"\",\n \"\"\n ],\n \"gmaps_image_url\": \"\",\n \"gmaps_description\": \"\",\n \"gmaps_amenities\": [\n \"\",\n \"\"\n ],\n \"gmaps_coordinates\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"google_place_id\": \"\",\n \"gmaps_link\": \"\",\n \"gmaps_phone_e164\": \"\",\n \"gmaps_phone_type\": \"\",\n \"gmaps_phone_valid\": \"\",\n \"original_website\": \"\",\n \"domain\": \"\",\n \"domain_filtered\": false,\n \"filter_reason\": \"\",\n \"spidersite_status\": \"\",\n \"spidersite_error\": \"\",\n \"pages_crawled\": \"\",\n \"emails_found\": [\n \"\",\n \"\"\n ],\n \"phones_found\": [\n \"\",\n \"\"\n ],\n \"social_media\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"company_info\": {},\n \"lead_scoring\": {},\n \"logo\": \"\",\n \"compendium\": \"\",\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"logo_metadata\": {},\n \"compendium_metadata\": {},\n \"metadata\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"crawl_status\": \"\",\n \"spiderverify_status\": \"\",\n \"spiderverify_error\": \"\",\n \"emails_verified\": [\n {\n \"email\": \"\",\n \"status\": \"invalid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n },\n {\n \"email\": \"\",\n \"status\": \"unknown\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n }\n ],\n \"valid_emails_count\": 0,\n \"workflow_stage\": \"maps\"\n },\n {\n \"business_name\": \"\",\n \"business_place_id\": \"\",\n \"business_address\": \"\",\n \"business_phone\": \"\",\n \"business_rating\": \"\",\n \"business_reviews_count\": \"\",\n \"business_categories\": [\n \"\",\n \"\"\n ],\n \"gmaps_images\": [\n \"\",\n \"\"\n ],\n \"gmaps_image_url\": \"\",\n \"gmaps_description\": \"\",\n \"gmaps_amenities\": [\n \"\",\n \"\"\n ],\n \"gmaps_coordinates\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"google_place_id\": \"\",\n \"gmaps_link\": \"\",\n \"gmaps_phone_e164\": \"\",\n \"gmaps_phone_type\": \"\",\n \"gmaps_phone_valid\": \"\",\n \"original_website\": \"\",\n \"domain\": \"\",\n \"domain_filtered\": false,\n \"filter_reason\": \"\",\n \"spidersite_status\": \"\",\n \"spidersite_error\": \"\",\n \"pages_crawled\": \"\",\n \"emails_found\": [\n \"\",\n \"\"\n ],\n \"phones_found\": [\n \"\",\n \"\"\n ],\n \"social_media\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"company_info\": {},\n \"lead_scoring\": {},\n \"logo\": \"\",\n \"compendium\": \"\",\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"logo_metadata\": {},\n \"compendium_metadata\": {},\n \"metadata\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"crawl_status\": \"\",\n \"spiderverify_status\": \"\",\n \"spiderverify_error\": \"\",\n \"emails_verified\": [\n {\n \"email\": \"\",\n \"status\": \"risky\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n },\n {\n \"email\": \"\",\n \"status\": \"invalid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n }\n ],\n \"valid_emails_count\": 0,\n \"workflow_stage\": \"maps\"\n }\n ]\n }\n ],\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e58695-66bc-4707-8278-69c80091892f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "workflow-results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Include businesses that were filtered out", "type": "text/plain" }, "key": "include_filtered", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "jobs", "description": "", "item": [ { "name": "{job_id}", "description": "", "item": [ { "name": "results", "description": "", "item": [ { "id": "edf457dd-9ef4-4cd9-975f-739178a1cb87", "name": "Wait for workflow job completion (blocking)", "request": { "name": "Wait for workflow job completion (blocking)", "description": { "content": "Blocks until all workflow stages complete for a specific SpiderMaps job,\n then returns aggregated results from SpiderMaps + SpiderSite + SpiderVerify.\n\n **Timeouts:**\n - SpiderSite: 5 minutes per business\n - SpiderVerify: 2 minutes per business\n - Maximum total wait: 10 minutes\n\n **Partial Results:**\n If SpiderVerify times out but SpiderSite completed, returns partial results\n with SpiderSite data (compendium, emails_found, company_info, etc.)\n\n **Query Parameters:**\n - `wait=true` (default): Block until all businesses complete or timeout\n - `wait=false`: Return current status immediately (for polling)\n\n **Status Values:**\n - `queued` - Waiting for workers\n - `processing` - Currently being processed\n - `completed` - All stages finished successfully\n - `failed` - Processing failed\n - `partial` - SpiderVerify timed out but SpiderSite data available", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Wait for completion (blocking). If false, returns current state immediately.", "type": "text/plain" }, "key": "wait", "value": "true" } ], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a06771bf-b00c-4418-bd93-24db515468db", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Wait for completion (blocking). If false, returns current state immediately.", "type": "text/plain" }, "key": "wait", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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" } ], "body": "{\n \"success\": \"\",\n \"job_id\": \"\",\n \"campaign_id\": \"\",\n \"status\": \"partial\",\n \"progress\": {\n \"current_stage\": \"\",\n \"elapsed_seconds\": \"\",\n \"stages\": [\n {\n \"stage\": \"maps\",\n \"status\": \"\",\n \"job_id\": \"\",\n \"error\": \"\"\n },\n {\n \"stage\": \"verify\",\n \"status\": \"\",\n \"job_id\": \"\",\n \"error\": \"\"\n }\n ],\n \"spidersite_timeout_remaining_seconds\": \"\",\n \"spiderverify_timeout_remaining_seconds\": \"\"\n },\n \"businesses_total\": 0,\n \"businesses_with_domains\": 0,\n \"businesses_filtered\": 0,\n \"spidersite_completed\": 0,\n \"spidersite_failed\": 0,\n \"spiderverify_completed\": 0,\n \"spiderverify_failed\": 0,\n \"total_emails_found\": 0,\n \"total_valid_emails\": 0,\n \"businesses\": [\n {\n \"business_name\": \"\",\n \"business_place_id\": \"\",\n \"business_address\": \"\",\n \"business_phone\": \"\",\n \"business_rating\": \"\",\n \"business_reviews_count\": \"\",\n \"business_categories\": [\n \"\",\n \"\"\n ],\n \"business_website\": \"\",\n \"gmaps_images\": [\n \"\",\n \"\"\n ],\n \"gmaps_image_url\": \"\",\n \"gmaps_description\": \"\",\n \"gmaps_amenities\": [\n \"\",\n \"\"\n ],\n \"gmaps_coordinates\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"google_place_id\": \"\",\n \"gmaps_link\": \"\",\n \"gmaps_phone_e164\": \"\",\n \"gmaps_phone_type\": \"\",\n \"gmaps_phone_valid\": \"\",\n \"domain_filtered\": false,\n \"filter_reason\": \"\",\n \"spidersite_status\": \"\",\n \"pages_crawled\": \"\",\n \"emails_found\": [\n \"\",\n \"\"\n ],\n \"phones_found\": [\n \"\",\n \"\"\n ],\n \"social_media\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"company_info\": {},\n \"lead_scoring\": {},\n \"logo\": \"\",\n \"compendium\": \"\",\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"logo_metadata\": {},\n \"compendium_metadata\": {},\n \"metadata\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"crawl_status\": \"\",\n \"spiderverify_status\": \"\",\n \"emails_verified\": [\n {\n \"email\": \"\",\n \"status\": \"valid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n },\n {\n \"email\": \"\",\n \"status\": \"unknown\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n }\n ],\n \"valid_emails_count\": 0,\n \"spidersite_error\": \"\",\n \"spiderverify_error\": \"\"\n },\n {\n \"business_name\": \"\",\n \"business_place_id\": \"\",\n \"business_address\": \"\",\n \"business_phone\": \"\",\n \"business_rating\": \"\",\n \"business_reviews_count\": \"\",\n \"business_categories\": [\n \"\",\n \"\"\n ],\n \"business_website\": \"\",\n \"gmaps_images\": [\n \"\",\n \"\"\n ],\n \"gmaps_image_url\": \"\",\n \"gmaps_description\": \"\",\n \"gmaps_amenities\": [\n \"\",\n \"\"\n ],\n \"gmaps_coordinates\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"google_place_id\": \"\",\n \"gmaps_link\": \"\",\n \"gmaps_phone_e164\": \"\",\n \"gmaps_phone_type\": \"\",\n \"gmaps_phone_valid\": \"\",\n \"domain_filtered\": false,\n \"filter_reason\": \"\",\n \"spidersite_status\": \"\",\n \"pages_crawled\": \"\",\n \"emails_found\": [\n \"\",\n \"\"\n ],\n \"phones_found\": [\n \"\",\n \"\"\n ],\n \"social_media\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"company_info\": {},\n \"lead_scoring\": {},\n \"logo\": \"\",\n \"compendium\": \"\",\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"logo_metadata\": {},\n \"compendium_metadata\": {},\n \"metadata\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"crawl_status\": \"\",\n \"spiderverify_status\": \"\",\n \"emails_verified\": [\n {\n \"email\": \"\",\n \"status\": \"invalid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n },\n {\n \"email\": \"\",\n \"status\": \"valid\",\n \"score\": 0,\n \"is_deliverable\": false,\n \"is_free_email\": false,\n \"is_disposable\": false,\n \"is_role_account\": false,\n \"is_catch_all\": false,\n \"has_gravatar\": false,\n \"domain_info\": {},\n \"quality\": \"\",\n \"sub_status\": \"\"\n }\n ],\n \"valid_emails_count\": 0,\n \"spidersite_error\": \"\",\n \"spiderverify_error\": \"\"\n }\n ],\n \"processing_time_seconds\": \"\",\n \"spidersite_timed_out\": false,\n \"spiderverify_timed_out\": false,\n \"error_message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78e080c9-9299-4d02-8a41-c7cfb53cb91b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns", ":campaign_id", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Wait for completion (blocking). If false, returns current state immediately.", "type": "text/plain" }, "key": "wait", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "id": "7070edf2-6c60-4031-8e3f-e28901c22c94", "name": "List campaigns", "request": { "name": "List campaigns", "description": { "content": "List all campaigns for the current client.\n\n **Filter Options:**\n - `status`: Filter by campaign status (active, paused, completed, stopped)\n - `country_code`: Filter by country", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Campaign status", "type": "text/plain" }, "key": "status", "value": "stopped" }, { "disabled": false, "description": { "content": "Country code", "type": "text/plain" }, "key": "country_code", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "55846ba7-328b-4501-a6df-0882843580b1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Campaign status", "type": "text/plain" }, "key": "status", "value": "stopped" }, { "disabled": false, "description": { "content": "Country code", "type": "text/plain" }, "key": "country_code", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "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" } ], "body": "{\n \"campaigns\": [\n {\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"query\": \"\",\n \"country_code\": \"\",\n \"total_locations\": \"\",\n \"locations_completed\": \"\",\n \"locations_failed\": \"\",\n \"progress_percentage\": \"\",\n \"created_at\": \"\",\n \"name\": \"\"\n },\n {\n \"campaign_id\": \"\",\n \"status\": \"\",\n \"query\": \"\",\n \"country_code\": \"\",\n \"total_locations\": \"\",\n \"locations_completed\": \"\",\n \"locations_failed\": \"\",\n \"progress_percentage\": \"\",\n \"created_at\": \"\",\n \"name\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"page_size\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7266d61-83d3-4fb9-81f6-c60d60b77756", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderMaps", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Campaign status", "type": "text/plain" }, "key": "status", "value": "stopped" }, { "disabled": false, "description": { "content": "Country code", "type": "text/plain" }, "key": "country_code", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "spiderSite", "description": "", "item": [ { "name": "submit", "description": "", "item": [ { "id": "b749fd34-a4e0-4207-964d-915ce2e515d2", "name": "Submit Spider Site Job", "request": { "name": "Submit Spider Site Job", "description": { "content": "Submit a SpiderSite lead generation job\n\n## Overview\nIntelligent website crawling with AI-powered lead extraction and CHAMP scoring.\n\n## Version Features\n- **v2.7.0 (NEW)**: AI Context Engine with smart markdown compendiums + R2 storage\n- **v2.4.0**: SPA auto-detection with Playwright rendering\n- **v2.3.0**: Sitemap-first crawling with intelligent page selection\n- **v2.2.1**: AI opt-in defaults (0 tokens unless explicitly enabled)\n- **v2.1.0**: Multilingual support (36+ European languages)\n\n## AI Context Engine (v2.7.0)\nAutomatically generates intelligent markdown compendiums optimized for LLMs:\n- **4 cleanup levels**: `raw` (100% fidelity), `fit` (60% size), `citations` (70% academic), `minimal` (30% size, 70% token savings)\n- **Smart deduplication**: Hash-based duplicate removal (20-40% size reduction)\n- **3-tier storage**: Inline (<1MB), Database (1-10MB), R2 cloud (>10MB with 24hr signed URLs)\n- **Configurable**: `compendium.cleanup_level`, `compendium.max_chars`, `compendium.remove_duplicates`\n- **Default**: Enabled with `fit` cleanup level\n\n## AI Token Usage (All Optional)\nBy default, **zero AI tokens** are used. Enable features as needed:\n- `extract_team: true` - ~500 tokens (team members with names, titles, emails, LinkedIn)\n- `extract_company_info: true` - ~500 tokens (company summary, services, industry)\n- `extract_pain_points: true` - ~500 tokens (business challenges from content)\n- CHAMP scoring - ~1,500 tokens (requires both `product_description` and `icp_description`)\n\n**Total cost if all enabled**: ~3,000 tokens per job\n\n## SPA Support (v2.4.0)\nAutomatically detects JavaScript-heavy sites (React, Vue, Angular) and uses Playwright:\n- `enable_spa: true` - Auto-detect and render SPAs (recommended)\n- `spa_timeout: 30` - Page load timeout in seconds (10-120)\n\n## Crawling Strategy\n- **Sitemap-first**: Automatically uses sitemap.xml if available (v2.3.0)\n- **Best-first** (default): Intelligent page prioritization\n- **BFS/DFS**: Alternative strategies available\n\n## Multilingual\nWorks with 36+ European languages. `target_pages` automatically translated:\n- English: \"contact\", \"about\", \"team\"\n- German: \"kontakt\", \"über uns\", \"team\"\n- Spanish: \"contacto\", \"acerca de\", \"equipo\"\n\n## Processing Time\n- 5-15 seconds: Small sites (1-5 pages) without AI\n- 20-40 seconds: Medium sites (10-20 pages) with AI extraction\n- 40-60 seconds: Large sites (30-50 pages) with full AI + CHAMP scoring\n\n## Authentication\nRequires Bearer token: `Authorization: Bearer ::`\n\n## Queue Limits\nCrawl4AI queue: 5,000 jobs maximum\n\n## Returns\nJob ID and initial status. Use `/jobs/{job_id}/status` to check progress.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "29d9c262-f8e5-456f-8701-1b7c49551bbe", "name": "Job created and queued successfully", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"message\": \"\",\n \"from_cache\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c10fbf39-cf48-42c4-a4f4-8948bd1ffcc6", "name": "Authentication failed", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d8783bc-acb8-4009-abf2-c43a1dfa5ef4", "name": "Client account is inactive", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dde66c7-e8ea-421a-af53-9a4e883ca853", "name": "Validation error - Invalid payload", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "559ef9f1-07de-4cf7-886f-cb96987b6109", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 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": "Maximum requests allowed per minute", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "Requests remaining in current window", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Unix timestamp when rate limit resets", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c0fef1d-8e66-4268-8b1e-6f829f7e317c", "name": "Database error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "900fac33-8cf4-49b0-925d-fab0167ec175", "name": "Queue service unavailable", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderSite", "submit" ], "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 \"payload\": {\n \"url\": \"\",\n \"max_pages\": 10,\n \"crawl_strategy\": \"bestfirst\",\n \"target_pages\": [\n \"contact\",\n \"about\",\n \"team\",\n \"news\",\n \"blog\"\n ],\n \"enable_spa\": true,\n \"spa_timeout\": 30,\n \"extract_team\": false,\n \"extract_company_info\": false,\n \"extract_pain_points\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"timeout\": 30,\n \"compendium\": {\n \"enabled\": true,\n \"max_chars\": 100000,\n \"cleanup_level\": \"fit\",\n \"separator\": \"\\n\\n---\\n\\n\",\n \"include_in_response\": true,\n \"remove_duplicates\": true,\n \"priority_sections\": [\n \"main\",\n \"article\",\n \"content\"\n ]\n },\n \"custom_ai_prompt\": {\n \"enabled\": false,\n \"system_prompt\": \"\",\n \"user_prompt\": \"\",\n \"json_schema\": {},\n \"output_field_name\": \"custom_analysis\",\n \"model\": \"google/gemini-2.0-flash-exp:free\",\n \"temperature\": 0.1,\n \"max_tokens\": 4000\n },\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "spiderVerify", "description": "", "item": [ { "name": "submit", "description": "", "item": [ { "id": "6ea90ba1-9888-49da-835b-61503550a7f8", "name": "Submit Spider Verify Job", "request": { "name": "Submit Spider Verify Job", "description": { "content": "Submit a SpiderVerify email verification job\n\n## Overview\nVerify email deliverability at SMTP level using the Reacher backend.\n\n## Features\n- **Single email verification**: Verify one email at a time\n- **Bulk verification**: Verify up to 100 emails per request\n- **SMTP-level checking**: Actually connects to mail servers\n- **Catch-all detection**: Identifies domains that accept all emails\n- **Disposable detection**: Flags temporary email providers\n- **Role account detection**: Identifies info@, support@, etc.\n- **Optional DNSBL checking**: Spam trap risk assessment\n\n## Rate Limiting\n3 seconds between emails to avoid IP blocking (~20 emails/minute)\n\n## Required Parameters\nEither `email` (single) OR `emails` (bulk, max 100) must be provided\n\n## Verification Status Values\n- `valid`: Email is deliverable (safe to send)\n- `invalid`: Email does not exist or is disabled\n- `risky`: Email exists but has issues (catch-all, role account)\n- `unknown`: Could not determine (timeout, SMTP blocked)\n\n## Quality Scores\n- 80-100: Good quality, safe to send\n- 50-79: Risky, proceed with caution\n- 0-49: Bad quality, do not send\n\n## Processing Time\n- Single email: 3-10 seconds\n- Bulk (100 emails): 5-8 minutes (with rate limiting)\n\n## Authentication\nRequires Bearer token: `Authorization: Bearer ::`\n\n## Queue Limits\nSpiderVerify queue: 5,000 jobs maximum\n\n## Returns\nJob ID and initial status. Use `/jobs/{job_id}/results` to get verification results.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderVerify", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"email\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"from_email\": \"\",\n \"hello_name\": \"\",\n \"check_gravatar\": false,\n \"smtp_timeout_secs\": 45,\n \"check_dnsbl\": false,\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "86c10b90-2dea-45ee-8e57-693a2ed606ef", "name": "Job created and queued successfully", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderVerify", "submit" ], "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 \"payload\": {\n \"email\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"from_email\": \"\",\n \"hello_name\": \"\",\n \"check_gravatar\": false,\n \"smtp_timeout_secs\": 45,\n \"check_dnsbl\": false,\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"message\": \"\",\n \"from_cache\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "899ac35e-d8af-476f-a279-ed9957b56abf", "name": "Authentication failed", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderVerify", "submit" ], "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 \"payload\": {\n \"email\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"from_email\": \"\",\n \"hello_name\": \"\",\n \"check_gravatar\": false,\n \"smtp_timeout_secs\": 45,\n \"check_dnsbl\": false,\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f411ddfe-bf10-4538-9a0f-b2eca4926ddc", "name": "Client account is inactive", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderVerify", "submit" ], "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 \"payload\": {\n \"email\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"from_email\": \"\",\n \"hello_name\": \"\",\n \"check_gravatar\": false,\n \"smtp_timeout_secs\": 45,\n \"check_dnsbl\": false,\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9491b4dd-0741-4100-b43b-851fdc1c86f7", "name": "Validation error - Invalid payload", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderVerify", "submit" ], "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 \"payload\": {\n \"email\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"from_email\": \"\",\n \"hello_name\": \"\",\n \"check_gravatar\": false,\n \"smtp_timeout_secs\": 45,\n \"check_dnsbl\": false,\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af87019a-91ac-44ae-a0d8-a6d8e79c5605", "name": "Queue service unavailable", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderVerify", "submit" ], "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 \"payload\": {\n \"email\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"from_email\": \"\",\n \"hello_name\": \"\",\n \"check_gravatar\": false,\n \"smtp_timeout_secs\": 45,\n \"check_dnsbl\": false,\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "spiderPeople", "description": "", "item": [ { "name": "submit", "description": "", "item": [ { "id": "46524bd9-fe04-4e56-badb-8292cb65f2f8", "name": "Submit Spider People Job", "request": { "name": "Submit Spider People Job", "description": { "content": "Submit a SpiderPeople LinkedIn research job (v2.17.0)\n\n## Overview\nResearch LinkedIn profiles with 3 modes:\n- **profile**: Fetch profile data by LinkedIn URL\n- **search**: Find profiles using natural language queries\n- **research**: Generate AI-powered research reports\n\n## Modes\n\n### Profile Mode (default)\nFetch detailed LinkedIn profile data including experience, education, and contact info.\n\n**Required:** `linkedin_url`\n\n**Example:**\n```json\n{\n \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"https://www.linkedin.com/in/john-doe\"\n }\n}\n```\n\n### Search Mode\nSearch for LinkedIn profiles using natural language queries.\n\n**Required:** `search_query`\n\n**Example:**\n```json\n{\n \"payload\": {\n \"mode\": \"search\",\n \"search_query\": \"5 AI engineers in Israel\",\n \"search_limit\": 10\n }\n}\n```\n\n### Research Mode\nGenerate AI-powered research report for a person.\n\n**Required:** `linkedin_url`\n\n**Example:**\n```json\n{\n \"payload\": {\n \"mode\": \"research\",\n \"linkedin_url\": \"https://www.linkedin.com/in/john-doe\"\n }\n}\n```\n\n## Authentication\nRequires Bearer token: `Authorization: Bearer ::`\n\n## Queue Limits\nSpiderPeople queue: 5,000 jobs maximum\n\n## Returns\nJob ID and initial status. Use `/jobs/{job_id}/results` to get profile/search/research results.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "spiderPeople", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"\",\n \"search_query\": \"\",\n \"search_limit\": 10,\n \"person_name\": \"\",\n \"generate_summary\": false,\n \"extract_insights\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "07cd3b09-3e09-4e55-9e92-e0ce2561f3cb", "name": "Job created and queued successfully", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderPeople", "submit" ], "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 \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"\",\n \"search_query\": \"\",\n \"search_limit\": 10,\n \"person_name\": \"\",\n \"generate_summary\": false,\n \"extract_insights\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"message\": \"\",\n \"from_cache\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2930916-892b-4969-94a2-b95dc84dd800", "name": "Authentication failed", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderPeople", "submit" ], "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 \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"\",\n \"search_query\": \"\",\n \"search_limit\": 10,\n \"person_name\": \"\",\n \"generate_summary\": false,\n \"extract_insights\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228fdf6c-c315-4f7c-81f8-546217cd9002", "name": "Client account is inactive", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderPeople", "submit" ], "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 \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"\",\n \"search_query\": \"\",\n \"search_limit\": 10,\n \"person_name\": \"\",\n \"generate_summary\": false,\n \"extract_insights\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9530528-191f-4976-9969-17b1b89c53eb", "name": "Validation error - Invalid payload", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderPeople", "submit" ], "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 \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"\",\n \"search_query\": \"\",\n \"search_limit\": 10,\n \"person_name\": \"\",\n \"generate_summary\": false,\n \"extract_insights\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326d8511-c6c9-4eb9-bebc-d7b8cddedf5e", "name": "Queue service unavailable", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "spiderPeople", "submit" ], "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 \"payload\": {\n \"mode\": \"profile\",\n \"linkedin_url\": \"\",\n \"search_query\": \"\",\n \"search_limit\": 10,\n \"person_name\": \"\",\n \"generate_summary\": false,\n \"extract_insights\": false,\n \"product_description\": \"\",\n \"icp_description\": \"\",\n \"test\": false\n },\n \"priority\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "{job_id}", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "e0d36c9b-8f43-49b9-85e7-fd71cbdcef0b", "name": "Get Job Status", "request": { "name": "Get Job Status", "description": { "content": "Get status information for a specific job\n\nRequires:\n - Valid authentication in Authorization header\n - Job must belong to the authenticated client\n\nReturns:\n Detailed job status information", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", ":job_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f3ff5e18-697e-4244-af2b-61d856bfa0c9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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" } ], "body": "{\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"created_at\": \"\",\n \"queued_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"worker_id\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"processing_time_seconds\": \"\",\n \"pages_crawled\": \"\",\n \"error_message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51d04a76-c2c7-4bbe-b675-6bd9a789f21a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "results", "description": "", "item": [ { "id": "77154949-12cb-4b87-8b6f-b6f08a601e3e", "name": "Get Job Results", "request": { "name": "Get Job Results", "description": { "content": "Get results for a job\n\n**NEW FLAT STRUCTURE (v2.7.6+)**:\n- Flat, non-nested design matching industry standards (Firecrawl, Outscraper)\n- All fields guaranteed present (null vs missing values)\n- Social media platforms flat at data.{platform} level (not nested)\n- Filtered emails (removes Sentry/tracking garbage)\n- Renamed: crawl4ai_available → browser_rendering_available\n\n**Status Codes**:\n- **200 OK**: Job completed successfully, results available in `data` field\n- **202 Accepted**: Job is queued/processing, results not ready yet (poll this endpoint)\n- **400 Bad Request**: Invalid job ID format\n- **401 Unauthorized**: Authentication failed\n- **403 Forbidden**: Client account inactive\n- **404 Not Found**: Job doesn't exist or doesn't belong to your account\n- **410 Gone**: Job failed or was cancelled, no results available\n\n**Polling Workflow**:\n1. Submit job → Get job_id\n2. Poll GET /jobs/{job_id}/results\n3. If 202 → Wait and poll again\n4. If 200 → Results ready in `data` field\n5. If 410 → Job failed, check `error_message`\n\n**Authentication**:\nRequires Bearer token: `Authorization: Bearer ::`", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9085a408-39df-49db-bf6f-8c88104eb7fe", "name": "Job completed successfully - results are available", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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" } ], "body": "{\n \"success\": \"\",\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"processing_time_seconds\": \"\",\n \"worker_id\": \"\",\n \"completed_at\": \"\",\n \"data\": {\n \"url\": \"\",\n \"pages_crawled\": 0,\n \"crawl_status\": \"unknown\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"logo\": {},\n \"linkedin\": \"\",\n \"twitter\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"tiktok\": \"\",\n \"github\": \"\",\n \"pinterest\": \"\",\n \"snapchat\": \"\",\n \"reddit\": \"\",\n \"medium\": \"\",\n \"discord\": \"\",\n \"whatsapp\": \"\",\n \"telegram\": \"\",\n \"markdown_compendium\": \"\",\n \"compendium\": {},\n \"company_vitals\": {},\n \"pain_points\": {},\n \"lead_scoring\": {},\n \"personalization_hooks\": {},\n \"custom_analysis\": {},\n \"metadata\": {}\n },\n \"error_message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5707ce5-22b8-4904-95b8-b04f34ae6553", "name": "Job is queued or processing - results not ready yet. Poll this endpoint to check for completion.", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe176b23-86e2-49c4-b658-af11f0275128", "name": "Invalid job ID format", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8313959-6069-4453-b965-967b0b7c4218", "name": "Authentication failed", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95643c04-55e7-41ec-a22e-86ddd6c90b08", "name": "Client account is inactive", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be05027-1ce4-4904-824f-137aa03f6ddf", "name": "Job not found or doesn't belong to your account", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ac93c9c-de21-404d-b106-0490e292e1fb", "name": "Job failed or was cancelled - no results available", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f94f3cfd-32f2-4db4-a9bc-522bf44aa834", "name": "Internal validation error - Response serialization failed. This should NOT occur in normal operation. If you encounter this error, please contact support as it indicates a bug in the API.", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "7a70e80e-0ab4-4c3e-83ed-484ba34c7ccc", "name": "Cancel Job", "request": { "name": "Cancel Job", "description": { "content": "Cancel a queued or processing job\n\nNote:\n - Only jobs in 'queued' or 'processing' status can be cancelled\n - Completed or failed jobs cannot be cancelled\n\nRequires:\n - Valid authentication in Authorization header\n - Job must belong to the authenticated client\n\nReturns:\n Confirmation message", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "67ae4544-2975-43dc-ad06-5510c1f40332", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12a8b584-a024-46a4-b7dd-d81cfa38576d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "list", "description": "", "item": [ { "id": "eba756ff-039e-4e38-ab6f-ac899799b210", "name": "List Jobs", "request": { "name": "List Jobs", "description": { "content": "List jobs for the authenticated client\n\nFeatures:\n - Filter by status (queued, processing, completed, failed)\n - Filter by type (spiderMaps, spiderSite)\n - Pagination support\n\nRequires:\n - Valid authentication in Authorization header\n\nReturns:\n Paginated list of jobs", "type": "text/plain" }, "url": { "path": [ "api", "v1", "jobs", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by job status (This can only be one of queued,processing,completed,failed,cancelled)", "type": "text/plain" }, "key": "status_filter", "value": "cancelled" }, { "disabled": false, "description": { "content": "Filter by job type (This can only be one of spiderMaps,spiderSite,spiderVerify,spiderPeople)", "type": "text/plain" }, "key": "type_filter", "value": "spiderVerify" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e910f21d-3da2-4c32-9393-9a76eaf48608", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by job status (This can only be one of queued,processing,completed,failed,cancelled)", "type": "text/plain" }, "key": "status_filter", "value": "cancelled" }, { "disabled": false, "description": { "content": "Filter by job type (This can only be one of spiderMaps,spiderSite,spiderVerify,spiderPeople)", "type": "text/plain" }, "key": "type_filter", "value": "spiderVerify" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "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" } ], "body": "{\n \"total\": \"\",\n \"page\": \"\",\n \"page_size\": \"\",\n \"jobs\": [\n {\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"created_at\": \"\",\n \"queued_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"worker_id\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"processing_time_seconds\": \"\",\n \"pages_crawled\": \"\",\n \"error_message\": \"\"\n },\n {\n \"job_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"created_at\": \"\",\n \"queued_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"worker_id\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"processing_time_seconds\": \"\",\n \"pages_crawled\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a0b3665-279d-476f-9c2b-c5a58195bda1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "jobs", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by job status (This can only be one of queued,processing,completed,failed,cancelled)", "type": "text/plain" }, "key": "status_filter", "value": "cancelled" }, { "disabled": false, "description": { "content": "Filter by job type (This can only be one of spiderMaps,spiderSite,spiderVerify,spiderPeople)", "type": "text/plain" }, "key": "type_filter", "value": "spiderVerify" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "system", "description": "", "item": [ { "name": "health", "description": "", "item": [ { "id": "66eb1381-5016-4f39-a2cc-c03754a77971", "name": "Health Check", "request": { "name": "Health Check", "description": { "content": "Health check endpoint for monitoring\n\nChecks:\n - API server status\n - PostgreSQL connection\n - Redis connection\n - RabbitMQ connection\n\nReturns:\n Service status information", "type": "text/plain" }, "url": { "path": [ "api", "v1", "system", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cdff250b-b4f7-44d0-b996-41123beeeda4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "system", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "queue-stats", "description": "", "item": [ { "id": "a74fdb69-8b8d-45f0-bc85-7551ae351843", "name": "Get Queue Stats", "request": { "name": "Get Queue Stats", "description": { "content": "Get queue statistics\n\nReturns:\n Current queue depths for all job types", "type": "text/plain" }, "url": { "path": [ "api", "v1", "system", "queue-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7f376734-5e56-42b1-9fd7-46ccb5d705d6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "system", "queue-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "info", "description": "", "item": [ { "id": "28121895-c24d-4741-b3c5-7a78310e4dfd", "name": "Get System Info", "request": { "name": "Get System Info", "description": { "content": "Get system information\n\nReturns:\n API configuration and version information", "type": "text/plain" }, "url": { "path": [ "api", "v1", "system", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "835534d2-d647-4f44-aece-ea6ee44dcdda", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "system", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "auto-search", "description": "", "item": [ { "id": "71f897e0-39b1-4e5c-aba3-4a7fb7296bf3", "name": "Submit new auto-search job", "request": { "name": "Submit new auto-search job", "description": { "content": "Submit a new auto-search job to automatically collect unique business results\n across a geographic area.\n\n The system will:\n 1. Generate location-specific queries based on the provided geography\n 2. Submit queries to SpiderMaps workers in batches\n 3. Deduplicate results by place_id\n 4. Stop when the total_limit is reached or all locations are exhausted\n 5. Upload results to R2 CDN\n\n **Examples:**\n - Search entire US: `{\"keyword\": \"dentist\", \"country\": \"US\"}`\n - Search California: `{\"keyword\": \"pizza\", \"country\": \"US\", \"state\": \"CA\"}`\n - Search Los Angeles: `{\"keyword\": \"hotel\", \"country\": \"US\", \"state\": \"CA\", \"city\": \"Los Angeles\"}`", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auto-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"keyword\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"total_limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "16a5afdd-a598-445d-b964-a82130fef3ff", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "auto-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 \"keyword\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"total_limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"auto_search_id\": \"\",\n \"status\": \"completed\",\n \"message\": \"\",\n \"estimated_queries\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1ec8ce3-73e1-4dd7-b7bd-c7297af475b2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "auto-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 \"keyword\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"total_limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef6984de-6433-4684-8cd1-8646582a5907", "name": "List auto-search jobs", "request": { "name": "List auto-search jobs", "description": { "content": "Get paginated list of all auto-search jobs for the authenticated client", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auto-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (starts at 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (max 100)", "type": "text/plain" }, "key": "page_size", "value": "20" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of pending,running,completed,failed,cancelled)", "type": "text/plain" }, "key": "status_filter", "value": "cancelled" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "41c52a69-0ec1-4872-b250-36f4e0592f55", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (starts at 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (max 100)", "type": "text/plain" }, "key": "page_size", "value": "20" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of pending,running,completed,failed,cancelled)", "type": "text/plain" }, "key": "status_filter", "value": "cancelled" } ], "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" } ], "body": "{\n \"auto_searches\": [\n {\n \"auto_search_id\": \"\",\n \"client_id\": \"\",\n \"keyword\": \"\",\n \"country\": \"\",\n \"status\": \"running\",\n \"created_at\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"total_limit\": \"\",\n \"unique_results_count\": \"\",\n \"queries_submitted\": \"\",\n \"queries_completed\": \"\",\n \"results_url\": \"\",\n \"completed_at\": \"\"\n },\n {\n \"auto_search_id\": \"\",\n \"client_id\": \"\",\n \"keyword\": \"\",\n \"country\": \"\",\n \"status\": \"cancelled\",\n \"created_at\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"total_limit\": \"\",\n \"unique_results_count\": \"\",\n \"queries_submitted\": \"\",\n \"queries_completed\": \"\",\n \"results_url\": \"\",\n \"completed_at\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"page_size\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ca289ac-c9a1-4ea4-afa6-cfea9b6e4fe0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (starts at 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (max 100)", "type": "text/plain" }, "key": "page_size", "value": "20" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of pending,running,completed,failed,cancelled)", "type": "text/plain" }, "key": "status_filter", "value": "cancelled" } ], "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{auto_search_id}", "description": "", "item": [ { "id": "bdb5ef35-d6f0-48a7-81a3-74d35d076508", "name": "Get auto-search status", "request": { "name": "Get auto-search status", "description": { "content": "Get detailed status and progress information for an auto-search job", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "auto_search_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "817c1a53-0d44-4fb5-9b22-7939ddd8a444", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "auto_search_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" } ], "body": "{\n \"auto_search_id\": \"\",\n \"client_id\": \"\",\n \"keyword\": \"\",\n \"country\": \"\",\n \"status\": \"running\",\n \"created_at\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"total_limit\": \"\",\n \"unique_results_count\": \"\",\n \"queries_submitted\": \"\",\n \"queries_completed\": \"\",\n \"results_url\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a449d4-ed14-4111-af37-8e73f700ef37", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "auto_search_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18ccf0f2-fa45-448b-80e5-78e8e30308dd", "name": "Cancel auto-search job", "request": { "name": "Cancel auto-search job", "description": { "content": "Cancel a running auto-search job.\n\n This will:\n 1. Delete the job-specific RabbitMQ queues (cancels pending queries)\n 2. Update the job status to 'cancelled'\n 3. Clean up Redis tracking data\n\n Already completed queries will remain in the results.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "auto_search_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0a89f426-09b7-43e6-94b4-831158ef1873", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "auto_search_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" } ], "body": "{\n \"auto_search_id\": \"\",\n \"status\": \"pending\",\n \"message\": \"\",\n \"pending_jobs_cancelled\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5360bccc-21c7-4cdd-bdf3-320e0a7fb826", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "auto_search_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "results", "description": "", "item": [ { "id": "378802e3-8e14-48a5-86c5-cc252419440f", "name": "Get auto-search results", "request": { "name": "Get auto-search results", "description": { "content": "Get download URL and metadata for auto-search results", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "auto_search_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1657ede1-5917-4b88-a391-7b249c9cb715", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "auto_search_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" } ], "body": "{\n \"auto_search_id\": \"\",\n \"status\": \"failed\",\n \"unique_results_count\": \"\",\n \"results_url\": \"\",\n \"file_size_bytes\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6623811-3a71-47ba-9e7c-e0b17ece0d28", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "auto-search", ":auto_search_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "auto_search_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "locations", "description": "", "item": [ { "name": "import", "description": "", "item": [ { "id": "7d467498-9a93-4e7a-a846-d68bb1dde405", "name": "Import locations", "request": { "name": "Import locations", "description": { "content": "Import multiple locations into the database.\n\n **Use Cases:**\n - Add postcodes for a specific city (e.g., Paris postcodes 75001-75020)\n - Add custom locations for a region\n - Bulk import city data\n\n **Example - Add Paris postcodes:**\n ```json\n {\n \"country_code\": \"FR\",\n \"parent_city\": \"Paris\",\n \"location_type\": \"postcode\",\n \"locations\": [\n {\"search_string\": \"75001, France\", \"display_name\": \"Paris 1er\", \"latitude\": 48.86, \"longitude\": 2.34},\n {\"search_string\": \"75002, France\", \"display_name\": \"Paris 2ème\", \"latitude\": 48.87, \"longitude\": 2.34}\n ]\n }\n ```", "type": "text/plain" }, "url": { "path": [ "api", "v1", "locations", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\",\n \"locations\": [\n {\n \"search_string\": \"\",\n \"display_name\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"admin_region\": \"\",\n \"population\": \"\"\n }\n ],\n \"country_name\": \"\",\n \"location_type\": \"city\",\n \"parent_city\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f834f652-1bbe-4684-b47b-acfcc02eeb4f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "locations", "import" ], "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 \"country_code\": \"\",\n \"locations\": [\n {\n \"search_string\": \"\",\n \"display_name\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"admin_region\": \"\",\n \"population\": \"\"\n }\n ],\n \"country_name\": \"\",\n \"location_type\": \"city\",\n \"parent_city\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"imported\": \"\",\n \"skipped\": 0,\n \"errors\": [\n \"\",\n \"\"\n ],\n \"location_ids\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be92b673-aaf8-41a1-8c3d-b314ba461ccc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "locations", "import" ], "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 \"country_code\": \"\",\n \"locations\": [\n {\n \"search_string\": \"\",\n \"display_name\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"admin_region\": \"\",\n \"population\": \"\"\n }\n ],\n \"country_name\": \"\",\n \"location_type\": \"city\",\n \"parent_city\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "bcabb2f0-91e2-451c-b020-bac7e1e2b831", "name": "List locations", "request": { "name": "List locations", "description": { "content": "List locations with filtering and pagination.\n\n **Filter Options:**\n - `country_code`: Filter by ISO 2-letter country code (e.g., FR, DE, US)\n - `location_type`: Filter by type (city or postcode)\n - `parent_city`: Filter postcodes by parent city\n - `admin_region`: Filter by state/province/region\n - `min_population` / `max_population`: Filter by population range\n - `needs_postcodes`: Filter big cities that need postcode breakdown\n - `search`: Search in display_name or search_string", "type": "text/plain" }, "url": { "path": [ "api", "v1", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 2-letter country code", "type": "text/plain" }, "key": "country_code", "value": "" }, { "disabled": false, "description": { "content": "Location type", "type": "text/plain" }, "key": "location_type", "value": "city" }, { "disabled": false, "description": { "content": "Parent city (for postcodes)", "type": "text/plain" }, "key": "parent_city", "value": "" }, { "disabled": false, "description": { "content": "State/Province/Region", "type": "text/plain" }, "key": "admin_region", "value": "" }, { "disabled": false, "description": { "content": "Minimum population", "type": "text/plain" }, "key": "min_population", "value": "" }, { "disabled": false, "description": { "content": "Maximum population", "type": "text/plain" }, "key": "max_population", "value": "" }, { "disabled": false, "description": { "content": "Filter big cities needing postcodes", "type": "text/plain" }, "key": "needs_postcodes", "value": "" }, { "disabled": false, "description": { "content": "Search in display_name or search_string", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "548e8247-aef2-4835-8ae7-b2557ef0b2c2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 2-letter country code", "type": "text/plain" }, "key": "country_code", "value": "" }, { "disabled": false, "description": { "content": "Location type", "type": "text/plain" }, "key": "location_type", "value": "city" }, { "disabled": false, "description": { "content": "Parent city (for postcodes)", "type": "text/plain" }, "key": "parent_city", "value": "" }, { "disabled": false, "description": { "content": "State/Province/Region", "type": "text/plain" }, "key": "admin_region", "value": "" }, { "disabled": false, "description": { "content": "Minimum population", "type": "text/plain" }, "key": "min_population", "value": "" }, { "disabled": false, "description": { "content": "Maximum population", "type": "text/plain" }, "key": "max_population", "value": "" }, { "disabled": false, "description": { "content": "Filter big cities needing postcodes", "type": "text/plain" }, "key": "needs_postcodes", "value": "" }, { "disabled": false, "description": { "content": "Search in display_name or search_string", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "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" } ], "body": "{\n \"locations\": [\n {\n \"location_id\": \"\",\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"search_string\": \"\",\n \"location_type\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"parent_city\": \"\",\n \"admin_region\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"population\": \"\",\n \"needs_postcodes\": false\n },\n {\n \"location_id\": \"\",\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"search_string\": \"\",\n \"location_type\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"parent_city\": \"\",\n \"admin_region\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"population\": \"\",\n \"needs_postcodes\": false\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"page_size\": \"\",\n \"total_pages\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501697f8-418d-42e9-83cd-c0a58ec286cf", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 2-letter country code", "type": "text/plain" }, "key": "country_code", "value": "" }, { "disabled": false, "description": { "content": "Location type", "type": "text/plain" }, "key": "location_type", "value": "city" }, { "disabled": false, "description": { "content": "Parent city (for postcodes)", "type": "text/plain" }, "key": "parent_city", "value": "" }, { "disabled": false, "description": { "content": "State/Province/Region", "type": "text/plain" }, "key": "admin_region", "value": "" }, { "disabled": false, "description": { "content": "Minimum population", "type": "text/plain" }, "key": "min_population", "value": "" }, { "disabled": false, "description": { "content": "Maximum population", "type": "text/plain" }, "key": "max_population", "value": "" }, { "disabled": false, "description": { "content": "Filter big cities needing postcodes", "type": "text/plain" }, "key": "needs_postcodes", "value": "" }, { "disabled": false, "description": { "content": "Search in display_name or search_string", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "countries", "description": "", "item": [ { "id": "8b79fa40-a5eb-48e1-a8b0-a871c3339c4a", "name": "List available countries", "request": { "name": "List available countries", "description": { "content": "Get list of all countries with location counts.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "locations", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "42463a15-7aea-4fc4-a28a-85eabf6b1a03", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "locations", "countries" ], "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" } ], "body": "{\n \"countries\": [\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"location_count\": \"\"\n },\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"location_count\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "stats", "description": "", "item": [ { "id": "edbffc5c-739f-46f0-8887-50b865e4a066", "name": "Get location statistics", "request": { "name": "Get location statistics", "description": { "content": "Get overall location database statistics.\n\n Returns:\n - Total locations, countries, cities, postcodes\n - Count of cities needing postcode breakdown\n - Top 20 countries by location count", "type": "text/plain" }, "url": { "path": [ "api", "v1", "locations", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f63bc269-0cb9-4d08-bb2f-8727b73e9b32", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "locations", "stats" ], "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" } ], "body": "{\n \"total_locations\": \"\",\n \"total_countries\": \"\",\n \"total_cities\": \"\",\n \"total_postcodes\": \"\",\n \"cities_needing_postcodes\": \"\",\n \"top_countries\": [\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"total_locations\": \"\",\n \"cities\": \"\",\n \"postcodes\": \"\",\n \"needs_postcodes\": \"\"\n },\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"total_locations\": \"\",\n \"cities\": \"\",\n \"postcodes\": \"\",\n \"needs_postcodes\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{location_id}", "description": "", "item": [ { "id": "bb364a90-6adc-4a79-bb4b-75cef4bf9a55", "name": "Get location by ID", "request": { "name": "Get location by ID", "description": { "content": "Get details of a specific location.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "locations", ":location_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "location_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "04a52851-83c6-484e-8804-bdbfaa3bf122", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "locations", ":location_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "location_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" } ], "body": "{\n \"location_id\": \"\",\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"search_string\": \"\",\n \"location_type\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"parent_city\": \"\",\n \"admin_region\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"population\": \"\",\n \"needs_postcodes\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc4e604b-f946-4ecd-aeed-67942eefeb5b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "locations", ":location_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "location_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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "/", "description": "", "item": [ { "id": "a4c97c92-85cd-4307-9576-01ace7887601", "name": "Root", "request": { "name": "Root", "description": { "content": "Root endpoint - redirect to docs", "type": "text/plain" }, "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d312faa7-d018-41f7-91ee-cac476d3d8f9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "/" } ], "info": { "_postman_id": "be93f0dd-d60f-46c9-8e9a-7710dd60b36f", "name": "SpiderIQ API Gateway", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Distributed Web Scraping Platform with RabbitMQ Job Queue", "type": "text/plain" } } }