{"openapi":"3.1.0","info":{"title":"RichAPI API","version":"1.0.0","description":"Public endpoint reference."},"servers":[{"url":"https://api.richapi.ai/api/v1"}],"tags":[{"name":"Getting Started","description":"Make your first API call in under 5 minutes.\n\n## Base URL\n\n`https://api.richapi.ai/api/v1/`\n\n## Authentication\n\nEvery request requires an API key passed via the `x-api-key` header.\n\n**cURL**\n\n```bash\ncurl https://api.richapi.ai/api/v1/my-endpoints \\\n  -H \"x-api-key: YOUR_API_KEY\"\n```\n\n**Python**\n\n```python\nimport requests\n\nresponse = requests.get(\n    \"https://api.richapi.ai/api/v1/my-endpoints\",\n    headers={\"x-api-key\": \"YOUR_API_KEY\"},\n)\nprint(response.json())\n```\n\n**JavaScript**\n\n```javascript\nconst response = await fetch(\"https://api.richapi.ai/api/v1/my-endpoints\", {\n  headers: { \"x-api-key\": \"YOUR_API_KEY\" },\n});\nconsole.log(await response.json());\n```\n\n### Your First API Call\n\nEnrich a B2B profile:\n\n**cURL**\n\n```bash\ncurl -X POST https://api.richapi.ai/api/v1/enrich_profile \\\n  -H \"x-api-key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"url\": \"https://www.linkedin.com/in/satyanadella\"}'\n```\n\n**Python**\n\n```python\nimport requests\n\nresponse = requests.post(\n    \"https://api.richapi.ai/api/v1/enrich_profile\",\n    headers={\n        \"x-api-key\": \"YOUR_API_KEY\",\n        \"Content-Type\": \"application/json\",\n    },\n    json={\"url\": \"https://www.linkedin.com/in/satyanadella\"},\n)\nprint(response.json())\n```\n\n**JavaScript**\n\n```javascript\nconst response = await fetch(\"https://api.richapi.ai/api/v1/enrich_profile\", {\n  method: \"POST\",\n  headers: {\n    \"x-api-key\": \"YOUR_API_KEY\",\n    \"Content-Type\": \"application/json\",\n  },\n  body: JSON.stringify({ url: \"https://www.linkedin.com/in/satyanadella\" }),\n});\nconst profile = await response.json();\nconsole.log(profile);\n```\n\nResponse:\n\n```json\n{\n  \"firstname\": \"Satya\",\n  \"lastname\": \"Nadella\",\n  \"headline\": \"Chairman and CEO at Microsoft\",\n  \"summary\": \"...\",\n  \"picture\": \"https://...\",\n  \"industry\": \"Technology\",\n  \"location\": {\n    \"country\": \"United States\",\n    \"city\": \"Redmond\",\n    \"state\": \"Washington\"\n  }\n}\n```\n\n### Check Your Usage\n\nMonitor your credit consumption anytime:\n\n**cURL**\n\n```bash\ncurl https://api.richapi.ai/api/v1/usage \\\n  -H \"x-api-key: YOUR_API_KEY\"\n```\n\n**Python**\n\n```python\nimport requests\n\nresponse = requests.get(\n    \"https://api.richapi.ai/api/v1/usage\",\n    headers={\"x-api-key\": \"YOUR_API_KEY\"},\n)\nprint(response.json())\n```\n\n**JavaScript**\n\n```javascript\nconst response = await fetch(\"https://api.richapi.ai/api/v1/usage\", {\n  headers: { \"x-api-key\": \"YOUR_API_KEY\" },\n});\nconsole.log(await response.json());\n```\n"},{"name":"Credits & Pricing","description":"Credit-based billing system.\n\n## Billing Rules\n\n- **Only successful calls are billed.** A non-2xx response deducts no credits.\n- **Per-result billing** (e.g. `people_search`) charges for the actual number of results returned, not the total available.\n- **Per-person/email billing** (e.g. email finding/verification) charges for the number of items in your `data` array.\n- **Inquiry-type endpoints are free.** Check results as many times as you want.\n\n## Checking Your Usage\n\n**cURL**\n\n```bash\n# Current month\ncurl https://api.richapi.ai/api/v1/usage \\\n  -H \"x-api-key: YOUR_API_KEY\"\n\n# Specific month\ncurl \"https://api.richapi.ai/api/v1/usage?month=2026-03\" \\\n  -H \"x-api-key: YOUR_API_KEY\"\n```\n\n**Python**\n\n```python\nimport requests\n\n# Current month\nresponse = requests.get(\n    \"https://api.richapi.ai/api/v1/usage\",\n    headers={\"x-api-key\": \"YOUR_API_KEY\"},\n)\nprint(response.json())\n\n# Specific month\nresponse = requests.get(\n    \"https://api.richapi.ai/api/v1/usage\",\n    headers={\"x-api-key\": \"YOUR_API_KEY\"},\n    params={\"month\": \"2026-03\"},\n)\nprint(response.json())\n```\n\n**JavaScript**\n\n```javascript\n// Current month\nconst response = await fetch(\"https://api.richapi.ai/api/v1/usage\", {\n  headers: { \"x-api-key\": \"YOUR_API_KEY\" },\n});\nconsole.log(await response.json());\n\n// Specific month\nconst monthly = await fetch(\"https://api.richapi.ai/api/v1/usage?month=2026-03\", {\n  headers: { \"x-api-key\": \"YOUR_API_KEY\" },\n});\nconsole.log(await monthly.json());\n```\n\nResponse:\n\n```json\n{\n  \"months\": [\"2026-03\"],\n  \"total_credits\": 42.5,\n  \"apis\": {\n    \"enrich_profile\": {\n      \"calls\": 25,\n      \"credits\": 25\n    },\n    \"people_search\": {\n      \"calls\": 5,\n      \"credits\": 17.5\n    }\n  }\n}\n```\n\n## Rate Limits\n\nEvery API key has a request-rate tier; exceeding it returns `429` with a\n`Retry-After` header indicating how many seconds to wait before retrying.\nStatus polls are exempt. See the Error Handling guide for the exact\nresponse shape.\n"},{"name":"Plans and credits","description":"Your organization can hold two wallets:\n\n- **Add-on credits** — the credits you buy. They never expire and pay for every endpoint.\n- **Plan credits** — granted by your plan on your billing day. They pay only for the\n  endpoints the plan covers, at the same price as add-on credits, and roll over for one\n  month at most (up to one month's grant).\n\nA call to a covered endpoint uses plan credits first, then add-on credits for the rest.\nOne call can be split across both. Calls to other endpoints use add-on credits. Team\nspend limits count the whole call, whichever credits pay for it, at your price.\n\n### Enrichment Pass\n\n60,000 plan credits a month, refilled on your billing day. Covers `enrich_companies_bulk`, `enrich_company`, `enrich_profile`, `enrich_profiles_bulk`.\n\n## When the plan credits run out\n\nThe organization owner chooses what happens, per plan:\n\n- `wallet` — the call continues on add-on credits.\n- `block` — covered calls return `402 plan_credits_exhausted` until the next refill.\n\nA single request can send `X-Plan-Overflow: block` to stop rather than spend add-on credits.\n`X-Plan-Overflow: wallet` only takes effect if the owner allowed it.\n\n## Credits in the response\n\nJSON object responses carry `richapi_meta.credits`:\n\n| Field | Meaning |\n|-------|---------|\n| `charged` | List credits of the whole call |\n| `from` | `plan`, `wallet`, `split` or `none` |\n| `plan_credits_charged` | Plan credits the call used |\n| `wallet_credits_charged` | Add-on credits the call used |\n| `plan_remaining` | Plan credits left |\n| `wallet_remaining` | Add-on credits left |\n| `resets_at` | Next refill; null when no refill is due |\n| `plan_status` | `active`, `canceling`, `past_due`, `refund_pending`, `disputed` |\n| `overflow` | The overflow mode the call ran under |\n\nThe plan fields appear only for an organization with a plan.\n\n## Checking both balances\n\n```bash\ncurl https://api.richapi.ai/api/v1/usage/allowance -H \"x-api-key: YOUR_API_KEY\"\n```\n\n## Retries\n\nA retry is a new request and is billed again. A 402, 429 or 503 response\ncharged nothing and is safe to retry.\n\n## Billing error codes\n\n<a id=\"insufficient_credits\"></a>\n\n#### `insufficient_credits`\n\nYour organization does not have enough credits for this request.\n\nFix: Top up credits on the Plan & credits page, or turn on auto-reload.\n\n<a id=\"spend_limit_reached\"></a>\n\n#### `spend_limit_reached`\n\nThis team has reached its monthly spend limit.\n\nFix: Ask an organization owner to raise the team's spend limit, or wait for it to reset.\n\n<a id=\"plan_credits_exhausted\"></a>\n\n#### `plan_credits_exhausted`\n\nYour plan has no plan credits left for this request, and its overflow is set to block.\n\nFix: Wait for the next refill, or have an organization owner switch overflow to add-on credits.\n\n<a id=\"plan_unavailable\"></a>\n\n#### `plan_unavailable`\n\nYour plan's balance could not be read, so the request was not run.\n\nFix: Retry shortly. Nothing was charged.\n\n<a id=\"invalid_plan_overflow\"></a>\n\n#### `invalid_plan_overflow`\n\nThe X-Plan-Overflow header must be 'wallet' or 'block'.\n\nFix: Send X-Plan-Overflow: block or X-Plan-Overflow: wallet, or leave it out.\n\n<a id=\"connection_spend_cap_reached\"></a>\n\n#### `connection_spend_cap_reached`\n\nThis MCP connection has reached its spend cap.\n\nFix: Raise the connection's spend cap in Connected Apps, or wait until the cap is raised.\n"},{"name":"Error Handling","description":"## HTTP Status Codes\n\n| Code | Meaning | Billed? |\n|------|---------|---------|\n| `200` / `201` | Success | Yes |\n| `400` | Bad Request — invalid parameters | No |\n| `401` / `403` | Unauthorized/Forbidden — missing or invalid API key | No |\n| `402` | Insufficient credits, plan credits exhausted, or team spend limit reached — see the `code` field | No |\n| `404` | Not Found — unknown endpoint | No |\n| `429` | Too Many Requests — quota exceeded | No |\n| `500` | Internal Server Error | No |\n| `502` / `504` | Upstream service error or timeout | No |\n\n## Error Response Format\n\nEvery error is a flat JSON object with an `error` string; some add fields specific to that failure:\n\n```json\n{\n  \"error\": \"Description of what went wrong\"\n}\n```\n\n## Common Errors\n\n### Missing or Invalid API Key (401 / 403)\n\n```json\n{\n  \"error\": \"No API access configured for this key\"\n}\n```\n\nFix: Add the `x-api-key` header to every request.\n\n### Unknown Endpoint (404)\n\n```json\n{\n  \"error\": \"Unknown API: nonexistent. Use GET /api/v1/my-endpoints to see available APIs.\"\n}\n```\n\nFix: Check the endpoint name. There is no `available_apis` list in the\nresponse body — use `GET /api/v1/my-endpoints` to see what's callable.\n\n### Insufficient Credits (402)\n\n```json\n{\n  \"error\": \"Insufficient credits\",\n  \"reserved\": \"5\",\n  \"balance\": \"2.5\"\n}\n```\n\nFix: Top up your account, or reduce the batch size of the request.\n\nEvery 402 also carries `code`, `message`, `fix`, `docs_url`, `resets_at`,\n`balances` and `plan_status`; the keys above stay for existing clients. The\ncodes (`insufficient_credits`, `plan_credits_exhausted`, `spend_limit_reached`)\nare explained in the Plans and credits guide. Billing codes are lowercase;\nolder `/api/v1` errors such as `ENDPOINT_UNDER_MAINTENANCE` keep their\nuppercase codes for historical reasons.\n\n### Too Many Requests (429)\n\n```json\n{\n  \"error\": \"Too Many Requests\"\n}\n```\n\nFix: Wait for the number of seconds given in the `Retry-After` response header, then retry.\n\n### Under Maintenance (503)\n\n```json\n{\n  \"error\": \"This endpoint is under maintenance. It will be available again soon.\",\n  \"code\": \"ENDPOINT_UNDER_MAINTENANCE\"\n}\n```\n\nFix: Temporary — retry later. Contact support if it persists.\n\n### Upstream / Timeout Errors (502 / 504)\n\n```json\n{\n  \"error\": \"The upstream service is temporarily unavailable. Please try again later.\"\n}\n```\n\nFix: This is a server-side issue. Retry with backoff (see below); if it persists, contact support.\n\n## Retry Strategy\n\nRetry `429`, `502`, and `504` with exponential backoff. Other 4xx errors will not succeed on retry without changing the request.\n\n```python\nimport time\nimport requests\n\ndef call_api(url, data, api_key, max_retries=3):\n    for attempt in range(max_retries):\n        response = requests.post(\n            url,\n            json=data,\n            headers={\n                \"x-api-key\": api_key,\n                \"Content-Type\": \"application/json\",\n            },\n        )\n\n        if response.status_code == 200:\n            return response.json()\n\n        if response.status_code in (429, 502, 504):\n            wait = 2 ** attempt  # 1s, 2s, 4s\n            time.sleep(wait)\n            continue\n\n        # Non-retryable error\n        response.raise_for_status()\n\n    raise Exception(\"Max retries exceeded\")\n```\n"},{"name":"AI","description":"Enrich, classify, extract, or summarize text using OpenAI, Anthropic, Gemini, or Perplexity."},{"name":"Activity","description":"Fetch recent posts, comments, and reactions from a B2B profile."},{"name":"Ads","description":"Search and inspect ad activity across Google, Meta and other ad libraries."},{"name":"Directory","description":"Look up structured business and contact directory data."},{"name":"Enrichment","description":"Enrich B2B profiles and company profiles with detailed data."},{"name":"Funding Data","description":"Look up company funding rounds and investor data."},{"name":"Leads","description":"Search and qualify leads by company and contact filters."},{"name":"Maps","description":"Search places and business listings via Google Maps."},{"name":"Posts","description":"Search and retrieve B2B posts by keyword or author."},{"name":"Search","description":"Search across 400M+ enriched B2B profiles and posts with powerful filters."},{"name":"Social","description":"Pull social metrics and links for a given profile or domain."},{"name":"Utilities","description":"Helper endpoints for parsing, normalizing, and formatting data."},{"name":"Waterfall","description":"Chain multiple providers to maximize match rate on a single request."},{"name":"Web Scraping","description":"Scrape and extract structured data from any web page."},{"name":"YouTube","description":"Search and retrieve YouTube channel, video, and search data."}],"x-tagGroups":[{"name":"Guides","tags":["Getting Started","Credits & Pricing","Plans and credits","Error Handling"]},{"name":"Endpoints","tags":["AI","Activity","Ads","Directory","Enrichment","Funding Data","Leads","Maps","Posts","Search","Social","Utilities","Waterfall","Web Scraping","YouTube"]}],"paths":{"/ai_enrich":{"post":{"operationId":"ai_enrich","summary":"AI Enrich","description":"Enrich, classify, extract, or summarize text using OpenAI, Anthropic, Gemini, or Perplexity.","tags":["AI"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","description":"AI provider: openai, anthropic, gemini, or perplexity","pattern":"^(openai|anthropic|gemini|perplexity)$","enum":["openai","anthropic","gemini","perplexity"]},"prompt":{"type":"string","description":"Prompt template; use {{fieldName}} placeholders for dynamic values"},"model":{"type":"string","description":"Model override; defaults to provider default model"},"temperature":{"type":"number","description":"Sampling temperature between 0 and 2","default":0.3},"context":{"type":"object","description":"Key-value pairs used for {{placeholder}} substitution in the prompt","default":{}},"system_prompt":{"type":"string","description":"Optional system prompt or instructions"},"output_type":{"type":"string","description":"Output format: text or json","default":"text","pattern":"^(text|json)$"},"output_schema":{"type":"object","description":"JSON schema used to guide structured output when output_type is json","default":{}},"max_tokens":{"type":"integer","description":"Maximum output tokens; defaults to provider default","default":4096},"use_web_search":{"type":"boolean","description":"Enable web search when supported by the selected provider","default":false},"search_domain_filter":{"type":"array","description":"Perplexity only; limit search to specific domains"},"search_recency_filter":{"type":"string","description":"Perplexity only; filter by recency: day, week, month, year","pattern":"^(day|week|month|year)?$","enum":["day","week","month","year"]}},"required":["prompt","provider"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"content":"Rich API automates outreach workflows.","finish_reason":"stop","input_tokens":18,"model":"gpt-4o-mini-2024-07-18","output_tokens":30,"provider":"openai","richapi_meta":{"credits":{"charged":2,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-0123456789","response_time_ms":1234},"tokens_used":15}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":2}}},"/b2b_ad_details":{"post":{"operationId":"b2b_ad_details","summary":"Fetch Ad Details","description":"Get full details of a specific ad including variants, impressions by country, and targeting","tags":["Ads"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ad_url":{"type":"string","description":"LinkedIn Ad Library detail URL (e.g. https://www.linkedin.com/ad-library/detail/1215501393)","pattern":"^https?://(www\\.)?linkedin\\.com/.+$"}},"required":["ad_url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"element":{"about":{"advertiserName":"Example Corp","advertiserUrl":"https://www.linkedin.com/company/example","format":"Single Image Ad","paidBy":"Example Corp"},"id":"1000000001","impressions":null,"targeting":null,"variants":[{"advertiser":{"headline":"Promoted","imageUrl":"https://example.com/images/sample.jpg","linkedinUrl":"https://www.linkedin.com/company/example","name":"Example Corp"},"content":{"ctaLabel":"Learn more","description":"Example ad body text.","headline":"An example headline","imageUrl":"https://example.com/images/sample.jpg","targetUrl":null},"creativeType":"SPONSORED_STATUS_UPDATE"}]},"query":{"url":"https://www.linkedin.com/ad-library/detail/1000000001"},"status":200}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":2}}},"/b2b_ad_search":{"post":{"operationId":"b2b_ad_search","summary":"Ad Search","description":"Search Ad Library for active ads by advertiser, keyword, or country","tags":["Ads"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"keyword":{"type":"string","description":"Keyword to search ads for"},"account_owner":{"type":"string","description":"Advertiser or company name"},"countries":{"type":"string","description":"Comma-separated country codes (e.g. 'US,GB') or 'ALL'","default":"ALL"},"date_option":{"type":"string","description":"Date range: last-30-days, current-month, current-year, last-year, or custom-date-range","enum":["last-30-days","current-month","current-year","last-year","custom-date-range"]},"start_date":{"type":"string","description":"Start date for custom range (YYYY-MM-DD)","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"end_date":{"type":"string","description":"End date for custom range (YYYY-MM-DD)","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"pagination_token":{"type":"string","description":"Pagination token from previous response"},"search_url":{"type":"string","description":"Full LinkedIn Ad Library search URL (alternative to individual filters)","pattern":"^https?://(?:www\\.)?linkedin\\.com/ad-library/.*$"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"advertiser":{"headline":"Promoted","imageUrl":"https://example.com/images/sample.jpg","name":"Example Corp"},"content":{"description":null,"headline":"An example headline","imageUrl":null,"pageUrl":"https://www.linkedin.com/ad-library/detail/1000000002"},"creativeType":"SPONSORED_STATUS_UPDATE","id":"1000000002"}],"pagination":{"pageNumber":null,"pageSize":24,"paginationToken":"1000000002-1700000000000","previousElements":null,"totalElements":240,"totalPages":10},"query":{"dateOption":"last-30-days","keyword":"example"},"status":200}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.2,"result_count_field":"elements"}}},"/clean_domain":{"post":{"operationId":"clean_domain","summary":"Clean Domain","description":"Normalize a messy URL or domain string to a clean root domain.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messy_url":{"type":"string","description":"URL or domain to normalize (e.g. https://www.Example.COM/page?q=1)","pattern":"^https?://[^\\s/$.?#].[^\\s]*$"}},"required":["messy_url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"clean_domain":"acme.com","clean_url":"https://www.acme.com","richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-0123456789","response_time_ms":100},"validated_domain":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/company_employees_search":{"post":{"operationId":"company_employees_search","summary":"Company Employees Search","description":"Search for employees of a specific company using its Company URL.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_linkedin_url":{"type":"string","description":"LinkedIn URL of the company","pattern":"^https?://([a-z]{2,3}\\.)?linkedin\\.com/company/[A-Za-z0-9%_\\-.]+/?$"},"page":{"type":"integer","description":"Page number for pagination","default":1}},"required":["company_linkedin_url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"hidden":true,"id":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","linkedinUrl":null,"location":{"linkedinText":"Bengaluru"},"name":"LinkedIn Member","photo":"https://example.com/images/sample.jpg","position":"Software Engineer at Example Corp","publicIdentifier":null}],"pagination":{"pageNumber":1,"pageSize":25,"previousElements":0,"totalElements":500,"totalPages":50,"totalResultCount":5000}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"elements"}}},"/company_posts":{"post":{"operationId":"company_posts","summary":"Fetch Company Posts","description":"Get recent posts published by a company. Supports filtering by date recency and cursor-based pagination.","tags":["Posts"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer","description":"Page number for pagination (1-based, default 1).","default":1},"linkedin_company_url":{"type":"string","description":"LinkedIn company URL (use this, linkedin_company_id, or linkedin_company_universal_name).","pattern":"^https?://([a-z]{2,3}\\.)?linkedin\\.com/company/[A-Za-z0-9%_\\-.]+/?$"},"linkedin_company_id":{"type":"string","description":"LinkedIn company numeric ID (fastest lookup)."},"linkedin_company_universal_name":{"type":"string","description":"Last path segment of the company LinkedIn URL (e.g. texauhq)."},"posted_limit":{"type":"string","description":"Pre-filter posts by recency: 24h, week, or month.","enum":["24h","week","month"]},"scrape_posted_limit":{"type":"string","description":"Scrape posts until this recency threshold is met: '1h', '24h', 'week','month', '3months', '6months', 'year'.","enum":["1h","24h","week","month","3months","6months","year"]}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"author":{"avatar":{"height":100,"url":"https://example.com/images/sample.jpg","width":100},"companyId":"1000001","id":"1000001","info":"10,000 followers","linkedinUrl":"https://www.linkedin.com/company/example/posts","name":"Example Corp","publicIdentifier":null,"type":"company","universalName":"example","urn":"1000001","website":null,"websiteLabel":null},"comments":[],"content":"Example company post text.","contentAttributes":[{"hyperlink":"https://www.linkedin.com/in/janedoe","length":8,"profile":{"firstName":"Jane","id":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","lastName":"Doe","linkedinUrl":"https://www.linkedin.com/in/janedoe","publicIdentifier":null},"start":0,"textLink":null,"type":"PROFILE_MENTION"}],"engagement":{"comments":100,"id":"7000000000000000000","likes":1200,"reactions":[{"count":900,"type":"LIKE"}],"shares":50},"entityId":"7000000000000000000","header":{"text":null},"id":"7000000000000000000","linkedinUrl":"https://www.linkedin.com/posts/example_example-post-activity-7000000000000000000","postImages":[],"postVideo":{"thumbnailUrl":"https://example.com/images/sample.jpg","videoUrl":"https://example.com/video.mp4"},"postedAt":{"date":"2024-01-01T00:00:00.000Z","postedAgoShort":"1d","postedAgoText":"1 day ago","timestamp":1704067200000},"shareLinkedinUrl":"https://www.linkedin.com/feed/update/urn:li:ugcPost:7000000000000000000","shareUrn":"urn:li:ugcPost:7000000000000000000","socialContent":{"hideSendAction":true,"hideShareAction":true,"shareUrl":"https://www.linkedin.com/posts/example_example-post-activity-7000000000000000000","trustInterventionBanner":null}}],"pagination":{"pageNumber":1,"pageSize":25,"previousElements":0,"totalElements":100,"totalPages":5}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"base_credits_per_call":0,"credits_per_result":0.2,"result_count_field":"elements"}}},"/company_search":{"post":{"operationId":"company_search","summary":"Company Search","description":"Search  companies by name, location, size, and industry. Returns company profiles with follower counts and summaries.","tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer","description":"Page number for pagination (1-based, default 1).","default":1},"search_query":{"type":"string","description":"Keywords to search for in company names."},"location":{"type":"string","description":"Filter companies by location (LinkedIn autocomplete; may be ambiguous - use geoId for precision)."},"geo_id":{"type":"string","description":"LinkedIn Geo ID - overrides location; use geo_id_search to resolve.","pattern":"^[0-9]+(,[0-9]+)*$"},"company_size":{"type":"string","description":"Comma-separated size ranges: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+.","enum":["1-10","51-200","201-500","501-1000","1001-5000","5001-10000","10001+"]},"linkedin_industry_id":{"type":"string","description":"LinkedIn industry ID. Comma-separated for multiple.","pattern":"^[0-9]+(,[0-9]+)*$"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"followers":"18M followers","id":"1234","industry":"Computers and Electronics Manufacturing","linkedinUrl":"https://www.linkedin.com/company/abc","location":{"linkedinText":"Cupertino, California"},"logo":"https://logo","name":"ABC","summary":null,"universalName":"abc"}],"error":null,"pagination":{"pageNumber":1,"pageSize":50,"previousElements":0,"totalElements":1000,"totalPages":20,"totalResultCount":37250751},"richapi_meta":{"credits":{"charged":5,"reason":"Charged for returned results.","reason_code":"per_result","remaining":98794.37,"status":"charged"},"request_id":"req-0123456789","response_time_ms":4923}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"base_credits_per_call":0,"credits_per_result":0.1,"result_count_field":"elements"}}},"/count_occurrences":{"post":{"operationId":"count_occurrences","summary":"Count Occurrences","description":"Count how many times a substring appears in a string, with optional case-insensitive matching.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string","description":"Input string to search within"},"separator":{"type":"string","description":"Substring to split and count by"},"case_insensitive":{"type":"boolean","description":"Case-insensitive matching (default false)","default":false},"limit":{"type":"integer","description":"Max results to return (0 for all, max 1000)","default":10}},"required":["input","separator"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"results":[{"count":1,"item":"world"}],"richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-0123456789","response_time_ms":100},"total_items":1,"unique_items":1}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/crunchbase_company_scraper_sync":{"post":{"operationId":"crunchbase_company_scraper_sync","summary":"Crunchbase Company Scraper","description":"Scrape Crunchbase company profiles — funding rounds, investors, employee count, and more.","tags":["Funding Data"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"crunchbase_company_url":{"type":"string","description":"URL of the company's profile on Crunchbase (e.g. https://www.crunchbase.com/organization/openai)","pattern":"^https?://(www\\.)?crunchbase\\.com/organization/[A-Za-z0-9%_\\-.]+/?$"}},"required":["crunchbase_company_url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"Accelerator Application Deadline":null,"Accelerator Duration (in weeks)":null,"Accelerator Program Type":null,"Acquired by":null,"Acquired by URL":null,"Acquisition Status":"Made Acquisitions","Acquisition Terms":null,"Acquisition Type":null,"Active Tech Count":45,"Actively Hiring":null,"Announced Date":null,"Announced Date Precision":null,"Average Visits (6 months)":240000.5,"Bounce Rate":0.45,"Bounce Rate Growth":-0.01,"CB Rank (Company)":12345,"CB Rank (Organization)":12345,"CB Rank (School)":null,"Closed Date":null,"Closed Date Precision":null,"Company Type":"For Profit","Contact Email":"hello@example.com","Contact Job Departments":"Engineering, Marketing, Sales","Date of Most Recent Valuation":null,"Delisted Date":null,"Delisted Date Precision":null,"Description":"Example Corp builds example products.","Diversity Spotlight":"Women Founded","Downloads Last 30 Days":1000,"Estimated Revenue Range":"$10M to $50M","Exit Date":null,"Exit Date Precision":null,"Facebook":"https://www.facebook.com/examplecorp","Founded Date":"01-01-2015","Founded Date Precision":"day","Founders":"Jane Doe, John Smith","Full Description":"Example Corp builds example products for example customers.","Funding Status":"Early Stage Venture","Global Traffic Rank":50000,"Growth Confidence":null,"Growth Score Tier":"Medium","Headquarters Location":"San Francisco, California, United States, North America","Headquarters Regions":"San Francisco Bay Area, West Coast","Heat Score Tier":"High","Hub Tags":"Unicorn","IPO Date":null,"IPO Status":"private","IT Spend":1500000,"IT Spend (in USD)":1500000,"IT Spend Currency":"USD","Industries":"Software, SaaS","Industry Groups":"Software","Investment Stage":"Early Stage Venture","Investor Type":"Venture_capital","Last Equity Funding Amount":25000000,"Last Equity Funding Amount (in USD)":25000000,"Last Equity Funding Amount Currency":"USD","Last Equity Funding Type":"Series B","Last Funding Amount":20000000,"Last Funding Amount (in USD)":20000000,"Last Funding Amount Currency":"USD","Last Funding Date":"2023-06-01","Last Funding Type":"Series B","Last Layoff Mention Date":"2024-02-01","Last Leadership Hiring Date":"01-06-2024","Lead Investors":"Example Ventures","LinkedIn":"https://www.linkedin.com/company/example","Money Raised at IPO":null,"Money Raised at IPO (in USD)":null,"Money Raised at IPO Currency":null,"Monthly Rank Change (#)":120,"Monthly Rank Growth":0.002,"Monthly Visits":250000,"Monthly Visits Growth":0.05,"Most Popular Patent Class":null,"Most Popular Trademark Class":"c9","Most Recent Valuation Range":null,"Number of Acquisitions":2,"Number of Alumni":null,"Number of Apps":2,"Number of Articles":120,"Number of Contacts":150,"Number of Diversity Investments":1,"Number of Employees":"101-250","Number of Enrollments":null,"Number of Events":2,"Number of Exits":1,"Number of Exits (IPO)":0,"Number of Founders":2,"Number of Founders (Alumni)":null,"Number of Funding Rounds":3,"Number of Investments":4,"Number of Investors":5,"Number of Lead Investments":1,"Number of Lead Investors":1,"Number of Portfolio Organizations":3,"Number of Private Contacts":null,"Number of Private Notes":null,"Number of Sub-Orgs":1,"Operating Status":"active","Organization Name":"Example Corp","Organization Name URL":"https://www.crunchbase.com/organization/example-corp","Page Views / Visit":2.5,"Page Views / Visit Growth":0.01,"Patents Granted":3,"Phone Number":"+1 555-010-0000","Postal Code":94105,"Price":null,"Price (in USD)":null,"Price Currency":null,"School Method":null,"School Program":null,"School Type":null,"Similar Companies":40,"Stock Exchange":null,"Stock Symbol":null,"Stock Symbol URL":null,"Top 5 Investors":"Example Ventures, Sample Capital","Total Equity Funding Amount":40000000,"Total Equity Funding Amount (in USD)":40000000,"Total Equity Funding Amount Currency":"USD","Total Funding Amount":35000000,"Total Funding Amount (in USD)":35000000,"Total Funding Amount Currency":"USD","Total Products Active":10,"Trademarks Registered":5,"Transaction Name":null,"Transaction Name URL":null,"Trend Score (30 Days)":0,"Trend Score (7 Days)":0,"Trend Score (90 Days)":0,"Twitter":"https://x.com/examplecorp","Valuation at IPO":null,"Valuation at IPO (in USD)":null,"Valuation at IPO Currency":null,"Visit Duration":180,"Visit Duration Growth":0.02,"Website":"https://example.com"}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":3}}},"/directory_yellowpages":{"post":{"operationId":"directory_yellowpages","summary":"Yellow Pages Search","description":"Search Yellow Pages for businesses with name, phone, address, website, and categories.","tags":["Directory"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search_query":{"type":"string","description":"Business type or name to search for."},"location":{"type":"string","description":"City, state, or ZIP code."},"page":{"type":"integer","description":"Page number for pagination (default 1).","default":1},"max_pages":{"type":"integer","description":"Maximum number of pages to scrape.","default":1}},"required":["location","search_query"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"businesses":[{"address":"123 Main St, Austin, TX 78701","categories":["Plumbers","Water Heaters"],"name":"ABC Plumbing","phone":"(512) 555-0123","rating":4.8,"website":"https://abcplumbing.example.com"}]},"meta":{"cache_hit":false,"execution_time_ms":1403,"quality_warning":null},"richapi_meta":{"credits":{"charged":0,"reason":"No billable results were returned, so this per-result endpoint did not consume credits.","reason_code":"per_result","remaining":1234,"status":"not_charged"},"request_id":"req-0123456789","response_time_ms":376}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"base_credits_per_call":0,"credits_per_result":0.01,"result_count_field":"_list_count"}}},"/distribute_leads":{"post":{"operationId":"distribute_leads","summary":"Distribute Leads","description":"Round-robin distribute leads across a set of assignment labels (e.g. sales reps).","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignment_labels":{"type":"string","description":"Comma-separated assignment labels (e.g. Team A,Team B,Team C)"},"values_associated_with_labels":{"type":"string","description":"Comma-separated values to distribute (e.g. alice@co.com,bob@co.com)"},"current_index":{"type":"integer","description":"Starting index for round-robin (default 0)","default":0}},"required":["values_associated_with_labels"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"assigned_label":"Team A","assigned_value":"alice@co.com","assignment_index":0,"next_index":1,"richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-0123456789","response_time_ms":114},"total_assignments":3}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/email_finder":{"post":{"operationId":"email_finder","summary":"Email Finder","description":"Find a verified work email using name, domain, or B2B Contact URL. Tries multiple providers automatically.","tags":["Enrichment"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"First name (required if no linkedin_url)"},"last_name":{"type":"string","description":"Last name (required if no linkedin_url)"},"company_domain":{"type":"string","description":"Company domain (required if no linkedin_url)","pattern":"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"},"linkedin_url":{"type":"string","description":"LinkedIn profile URL (alternative to name + domain)","pattern":"^https?://([a-z]{2,3}\\.)?linkedin\\.com/in/[A-Za-z0-9%_\\-.]+/?$"},"company_name":{"type":"string","description":"Company name (optional, improves accuracy)"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"execution_log":[{"latency_ms":850,"provider":"source_1","status":"success"}],"provider":"source_1","providers_tried":1,"result":{"email":"jane.doe@example.com","email_status":"valid","esp":"Google"},"success":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":5}}},"/email_verifier":{"post":{"operationId":"email_verifier","summary":"Email Verifier","description":"Verify email deliverability and validity via multi-provider waterfall.","tags":["Waterfall"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address to verify","pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"execution_log":[{"latency_ms":420,"provider":"source_1","status":"success"}],"provider":"source_1","providers_tried":1,"result":{"status":"valid"},"success":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":2}}},"/encode_uri":{"post":{"operationId":"encode_uri","summary":"Encode URI","description":"URL-encode a string for safe use in query parameters or path segments.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"String to URL-encode (RFC 3986)"}},"required":["value"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"encoded_value":"hello%20world%20%26%20foo%3Dbar","original_value":"hello world & foo=bar","richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-0123456789","response_time_ms":117}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/enrich":{"post":{"operationId":"enrich","summary":"Enrich","description":"Public page for a LinkedIn person, a LinkedIn company, or an Instagram, X, Facebook, or TikTok profile URL. LinkedIn costs 1 credit. Instagram, X, Facebook, and TikTok cost 0.6 credits. The response body is the matched page's body.","tags":["Social"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"LinkedIn person, LinkedIn company, Instagram, X, Facebook, or TikTok profile URL"}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"awards":[],"background":"https://example.com/images/sample.jpg","birthDate":null,"certifications":[],"courses":[],"creator":false,"educations":[{"date":{"end":"2008-01-01T00:00:00.000Z","start":"2004-01-01T00:00:00.000Z"},"degreeName":"Bachelor's Degree","fieldOfStudy":"Computer Science","grade":null,"school":{"id":1000004,"logo":"https://example.com/images/sample.jpg","name":"Example University","profileType":"COMPANY","url":"https://www.linkedin.com/school/example-university/"}}],"entityUrn":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","firstname":"Jane","headline":"Chief Executive Officer at Example Corp","hiring":false,"identifier":"janedoe","industry":"Computer Software","influencer":false,"languages":[],"lastname":"Doe","location":{"city":"Seattle","country":"United States","defaultValue":"Seattle, Washington, United States","shortValue":"Seattle, Washington","state":"Washington"},"middleName":null,"objectUrn":1000002,"openToWork":false,"organizations":[],"patents":[],"picture":"https://example.com/images/sample.jpg","positionGroups":[{"company":{"domain":"example.com","id":1000003,"logo":"https://example.com/images/sample.jpg","name":"Example Corp","profileType":"COMPANY","url":"https://www.linkedin.com/company/example/"},"date":{"end":null,"start":"2020-01-01T00:00:00.000Z"},"profilePositions":[{"company":"Example Corp","date":{"end":null,"start":"2020-01-01T00:00:00.000Z"},"description":null,"employmentType":null,"location":"Seattle","title":"Chief Executive Officer"}]}],"premium":false,"projects":[],"publications":[],"recommendations":[],"skills":[],"summary":"Example profile summary.","testScores":[],"url":"https://www.linkedin.com/in/janedoe","verified":null,"volunteerExperiences":[]}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/enrich_companies_bulk":{"post":{"operationId":"enrich_companies_bulk","summary":"Bulk Company Enrichment","description":"Fetch up to 50 B2B company profiles in a single call using company IDs.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urns":{"type":"array","description":"List of numeric LinkedIn company IDs (max 50)"}},"required":["urns"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"cover":"https://example.com/images/sample.jpg","description":"Example Corp builds example products.","followers":25000,"foundedYear":2000,"fundingData":null,"hashtags":["example"],"industries":["Software Development"],"locations":{"headquarter":{"city":"San Francisco","country":"US","geographicArea":"California","isPrimary":null,"line1":"1 Example Street","line2":null,"postalCode":"94105"},"other":[{"city":"Dublin","country":"IE","geographicArea":"County Dublin","isPrimary":null,"line1":"1 Example Terrace","line2":null,"postalCode":"D02 XXXX"}]},"logo":"https://example.com/images/sample.jpg","name":"Example Corp","objectUrn":1000001,"phone":null,"specialities":null,"staff":{"range":{"end":5000,"start":1001},"total":1500},"tagline":"An example tagline.","type":"Privately Held","universalName":"example","url":"https://www.linkedin.com/company/example","website":"https://example.com"}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":1,"result_count_field":"_list_count"},"x-plan-coverage":[{"plan_id":"pass_v1","plan":"Enrichment Pass"}]}},"/enrich_company":{"post":{"operationId":"enrich_company","summary":"Company Enrichment","description":"Get company data including size, industry, specialties and employee insights.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"LinkedIn company page URL"},"useCache":{"type":"boolean","description":"Return cached result if available (default true)","default":true}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"cover":"https://example.com/images/sample.jpg","description":"Example Corp builds example products.","followers":25000,"foundedYear":2000,"fundingData":null,"hashtags":["example"],"industries":["Software Development"],"locations":{"headquarter":{"city":"San Francisco","country":"US","geographicArea":"California","isPrimary":null,"line1":"1 Example Street","line2":null,"postalCode":"94105"},"other":[{"city":"Dublin","country":"IE","geographicArea":"County Dublin","isPrimary":null,"line1":"1 Example Terrace","line2":null,"postalCode":"D02 XXXX"}]},"logo":"https://example.com/images/sample.jpg","name":"Example Corp","objectUrn":1000001,"phone":null,"specialities":null,"staff":{"range":{"end":5000,"start":1001},"total":1500},"tagline":"An example tagline.","type":"Privately Held","universalName":"example","url":"https://www.linkedin.com/company/example","website":"https://example.com"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1},"x-plan-coverage":[{"plan_id":"pass_v1","plan":"Enrichment Pass"}]}},"/enrich_profile":{"post":{"operationId":"enrich_profile","summary":"Profile Enrichment","description":"Get B2B profile data including name, headline, location, experience, education and more. Base price is 1 credits per call. When `include_social_metrics` is `True`, the optional component adds 1 credits; it is not charged when unavailable.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"LinkedIn profile URL"},"include_social_metrics":{"type":"boolean","description":"Include social metrics for 1 additional credit when available.","default":false},"useCache":{"type":"boolean","description":"Return cached result if available (default true)","default":true}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"awards":[],"background":"https://example.com/images/sample.jpg","birthDate":null,"certifications":[],"courses":[],"creator":false,"educations":[{"date":{"end":"2008-01-01T00:00:00.000Z","start":"2004-01-01T00:00:00.000Z"},"degreeName":"Bachelor's Degree","fieldOfStudy":"Computer Science","grade":null,"school":{"id":1000004,"logo":"https://example.com/images/sample.jpg","name":"Example University","profileType":"COMPANY","url":"https://www.linkedin.com/school/example-university/"}}],"entityUrn":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","firstname":"Jane","headline":"Chief Executive Officer at Example Corp","hiring":false,"identifier":"janedoe","industry":"Computer Software","influencer":false,"languages":[],"lastname":"Doe","location":{"city":"Seattle","country":"United States","defaultValue":"Seattle, Washington, United States","shortValue":"Seattle, Washington","state":"Washington"},"middleName":null,"objectUrn":1000002,"openToWork":false,"organizations":[],"patents":[],"picture":"https://example.com/images/sample.jpg","positionGroups":[{"company":{"domain":"example.com","id":1000003,"logo":"https://example.com/images/sample.jpg","name":"Example Corp","profileType":"COMPANY","url":"https://www.linkedin.com/company/example/"},"date":{"end":null,"start":"2020-01-01T00:00:00.000Z"},"profilePositions":[{"company":"Example Corp","date":{"end":null,"start":"2020-01-01T00:00:00.000Z"},"description":null,"employmentType":null,"location":"Seattle","title":"Chief Executive Officer"}]}],"premium":false,"projects":[],"publications":[],"recommendations":[],"skills":[],"summary":"Example profile summary.","testScores":[],"url":"https://www.linkedin.com/in/janedoe","verified":null,"volunteerExperiences":[]}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1,"min_credits_per_call":1,"max_credits_per_call":2,"conditional_components":[{"id":"social_metrics","when":{"field":"include_social_metrics","equals":true},"credits_per_call":1,"description":"Optional component; unavailable components are not charged."}]},"x-plan-coverage":[{"plan_id":"pass_v1","plan":"Enrichment Pass"}]}},"/enrich_profiles_bulk":{"post":{"operationId":"enrich_profiles_bulk","summary":"Bulk Profile Enrichment","description":"Fetch up to 50 B2B profiles in a single call using entity URNs.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urns":{"type":"array","description":"List of LinkedIn entity URNs (max 50)"}},"required":["urns"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"awards":{"contents":[],"page":0,"size":20,"totalElements":0},"background":"https://example.com/images/sample.jpg","birthDate":null,"certifications":{"contents":[],"page":0,"size":20,"totalElements":0},"courses":{"contents":[],"page":0,"size":20,"totalElements":0},"creator":false,"educations":{"contents":[{"date":{"end":"2008-01-01T00:00:00.000Z","start":"2004-01-01T00:00:00.000Z"},"degreeName":"Bachelor's Degree","fieldOfStudy":"Computer Science","grade":null,"school":{"id":1000004,"logo":"https://example.com/images/sample.jpg","name":"Example University","profileType":"COMPANY","url":"https://www.linkedin.com/school/example-university/"}}],"page":0,"size":20,"totalElements":1},"entityUrn":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","firstname":"Jane","headline":"Chief Executive Officer at Example Corp","hiring":false,"identifier":"janedoe","industry":"Computer Software","influencer":false,"languages":{"contents":[],"page":0,"size":20,"totalElements":0},"lastname":"Doe","location":{"city":"Seattle","country":"United States","defaultValue":"Seattle, Washington, United States","shortValue":"Seattle, Washington","state":"Washington"},"middleName":null,"objectUrn":1000002,"openToWork":false,"organizations":{"contents":[],"page":0,"size":20,"totalElements":0},"patents":{"contents":[],"page":0,"size":20,"totalElements":0},"picture":"https://example.com/images/sample.jpg","positionGroups":{"contents":[{"company":{"domain":"example.com","id":1000003,"logo":"https://example.com/images/sample.jpg","name":"Example Corp","profileType":"COMPANY","url":"https://www.linkedin.com/company/example/"},"date":{"end":null,"start":"2020-01-01T00:00:00.000Z"},"profilePositions":[{"company":"Example Corp","date":{"end":null,"start":"2020-01-01T00:00:00.000Z"},"description":null,"employmentType":null,"location":"Seattle","title":"Chief Executive Officer"}]}],"page":0,"size":10,"totalElements":1},"premium":false,"projects":{"contents":[],"page":0,"size":20,"totalElements":0},"publications":{"contents":[],"page":0,"size":20,"totalElements":0},"skills":{"contents":[],"page":0,"size":20,"totalElements":0},"summary":"Example profile summary.","testScores":{"contents":[],"page":0,"size":20,"totalElements":0},"url":"https://www.linkedin.com/in/janedoe","verified":null,"volunteerExperiences":{"contents":[],"page":0,"size":20,"totalElements":0}}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":1,"result_count_field":"_list_count"},"x-plan-coverage":[{"plan_id":"pass_v1","plan":"Enrichment Pass"}]}},"/extract_urls_emails":{"post":{"operationId":"extract_urls_emails","summary":"Extract URLs & Emails","description":"Extract all URLs and email addresses from a block of text.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"Text block to extract URLs and emails from"}},"required":["text"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"email_count":1,"emails":["user@example.com"],"emails_string":"user@example.com","total_count":2,"url_count":1,"urls":["https://example.com/pricing"],"urls_and_emails":["https://example.com/pricing","user@example.com"],"urls_string":"https://example.com/pricing"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/find_company_profile_url":{"post":{"operationId":"find_company_profile_url","summary":"Find Company URL","description":"Find the company page URL for a company from its name.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_name":{"type":"string","description":"Company name to look up (e.g. Stripe)"},"company_domain":{"type":"string","description":"Company website domain, used to tell apart companies with similar names (e.g. stripe.com)"}},"required":["company_name"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"company_linkedin_url":"https://www.linkedin.com/company/example"},"message":"success"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.25}}},"/find_crunchbase_url":{"post":{"operationId":"find_crunchbase_url","summary":"Find Crunchbase URL","description":"Find the Crunchbase organization URL for a company from its name.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_name":{"type":"string","description":"Company name to look up (e.g. Stripe)"},"company_domain":{"type":"string","description":"Company website domain, used to tell apart companies with similar names (e.g. stripe.com)"}},"required":["company_name"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"crunchbase_url":"https://www.crunchbase.com/organization/stripe"},"message":"success"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.25}}},"/find_personal_email":{"post":{"operationId":"find_personal_email","summary":"Find Personal Email","description":"Finds a person's personal email addresses using their B2B profile URL.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"linkedin_url":{"type":"string","description":"LinkedIn profile URL of the person","pattern":"^https?://([a-z]{2,3}\\.)?linkedin\\.com/in/[A-Za-z0-9%_\\-.]+/?$"}},"required":["linkedin_url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"first_personal_email":"jane.doe@example.net","message":"Personal email found."}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":5}}},"/find_profile_url_by_email":{"post":{"operationId":"find_profile_url_by_email","summary":"Find Profile URL by Email","description":"Finds a profile URL using an email address.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the person","pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"LinkedIn Profile URL":"https://www.linkedin.com/in/abc"},"id":"1234","message":"success","richapi_meta":{"credits":{"charged":4,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-0123456789","response_time_ms":6485}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":4}}},"/find_profile_url_by_name":{"post":{"operationId":"find_profile_url_by_name","summary":"Find Profile URL by Name","description":"Finds a profile URL using full name and company name.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"type":"string","description":"Full name of the person (e.g. Satya Nadella)"},"company_name":{"type":"string","description":"Company name (e.g. Microsoft)"}},"required":["company_name","full_name"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"LinkedIn Profile URL":"https://www.linkedin.com/in/janedoe"},"message":"success"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":4}}},"/find_redirect":{"post":{"operationId":"find_redirect","summary":"Find Redirect","description":"Follow a URL through all redirects and return the final destination URL.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"URL to follow through all redirects to the final destination","pattern":"^https?://[^\\s/$.?#].[^\\s]*$"}},"required":["link"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"final_status_code":200,"is_redirected":true,"original_link":"http://example.com","redirect_chain":["http://example.com","https://example.com/"],"redirect_count":1,"redirect_link":"https://example.com/","resolved_successfully":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/find_sitemap_urls":{"post":{"operationId":"find_sitemap_urls","summary":"Find Sitemap URLs","description":"Discover and filter URLs from a domain's sitemap by keyword.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain to discover sitemap URLs from (e.g. stripe.com)","pattern":"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"},"keywords":{"type":"string","description":"Comma-separated keywords to filter URLs"},"exact_match":{"type":"boolean","description":"Match keywords exactly (default false)","default":false}},"required":["domain"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"domain":"https://example.com","filtered_urls":2,"sitemap_urls":["https://example.com/sitemap.xml"],"total_urls":120,"urls":["https://example.com/pricing","https://example.com/blog/pricing-guide"]}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/find_website_by_company_name":{"post":{"operationId":"find_website_by_company_name","summary":"Find Website by Company Name","description":"Finds a company website URL using its name.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company"},"company_domain":{"type":"string","description":"Company website domain, used to tell apart companies with similar names (e.g. stripe.com)"}},"required":["company_name"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"Website":"https://example.com/"},"message":"success","name":"example","richapi_meta":{"credits":{"charged":1,"reason":"Charged per successful call.","reason_code":"per_call","remaining":12345,"status":"charged"},"request_id":"req-0123456789","response_time_ms":6373}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/format_datetime":{"post":{"operationId":"format_datetime","summary":"Format Datetime","description":"Parse and reformat a date/time string with optional timezone conversion and locale.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","description":"Date/time string to parse (ISO 8601 or common formats)"},"format":{"type":"string","description":"strftime format string for output (e.g. %B %d, %Y)"},"original_timezone":{"type":"string","description":"Timezone of the input date (e.g. UTC)"},"new_timezone":{"type":"string","description":"Target timezone for output (e.g. America/New_York)"},"locale":{"type":"string","description":"Locale for month/day names (e.g. en, fr)"}},"required":["date"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"applied_locale":"en","applied_timezone":"UTC","day":15,"formatted_date":"2024-03-15 14:30:00","full_date_time":"2024-03-15 14:30:00","localized_date_time":"March 15, 2024 2:30:00 PM","localized_date_with_month_name":"March 15, 2024","localized_date_with_weekday":"Friday, March 15, 2024","localized_short_date":"03/15/2024","localized_time":"2:30:00 PM","month_name":"March","month_number":3,"original_input":"2024-03-15 14:30:00","parsed_successfully":true,"short_year":24,"time":"14:30:00","unix_timestamp":1710513000,"year":2024}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/geo_id_search":{"post":{"operationId":"geo_id_search","summary":"Geo ID Search","description":"Resolve a location name to a Geo ID for use with profile and lead search filters.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string","description":"Location name to search (e.g. 'San Francisco', 'London')"}},"required":["search"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"geoId":"123","title":"example"}],"pagination":null,"richapi_meta":{"credits":{"charged":0.01,"reason":"Charged per successful call.","reason_code":"per_call","remaining":1234,"status":"charged"},"request_id":"req-012345678","response_time_ms":2412}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.01}}},"/google_ad_transparency_scraper_sync":{"post":{"operationId":"google_ad_transparency_scraper_sync","summary":"Google Ad Transparency Scraper","description":"Scrape Google Ad Transparency reports — see active ads, creative formats, and geographic targeting.","tags":["Ads"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"google_ad_url":{"type":"string","description":"Google Ad Transparency search URL","pattern":"^https?://adstransparency\\.google\\.com/.+$"},"limit":{"type":"integer","description":"Max items to return (max 100)","default":0}},"required":["google_ad_url","limit"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"adUrl":"example","advertiserId":"example","creativeId":"example","format":"example","landingDomain":"example","landingUrls":[],"lastShown":"example"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"deprecated":true,"x-pricing":{"credits_per_result":3,"result_count_field":"_list_count"}}},"/google_maps_places_scraper_keyword":{"post":{"operationId":"google_maps_places_scraper_keyword","summary":"Google Maps Places (Keyword)","description":"Search for business places on Google Maps by keyword and location (e.g., 'cafe' in 'Pune').","tags":["Maps"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search_query":{"type":"string","description":"Fuzzy keyword search."},"location_query":{"type":"string","description":"Fuzzy location search."},"limit":{"type":"integer","description":"Maximum number of places to return (default is 25).","default":25}},"required":["limit","search_query"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"additionalInfo":{"Atmosphere":[{"Casual":true}],"Children":[{"Good for kids":true}],"Crowd":[{"Groups":true}],"Offerings":[{"Coffee":true},{"Quick bite":true},{"Small plates":true}],"Parking":[{"Free street parking":true},{"Usually plenty of parking":true}],"Payments":[{"NFC mobile payments":true}],"Popular for":[{"Solo dining":true}],"Service options":[{"Takeout":true},{"Dine-in":true},{"Delivery":false}]},"address":"example","businessProfileId":"example","categories":["example"],"categoryName":"example","checkInDate":null,"checkOutDate":null,"cid":"example","city":"example","claimThisBusiness":false,"countryCode":"example","description":null,"fid":"example","floor":null,"gasPrices":[],"googleFoodUrl":null,"hotelAds":[],"hotelDescription":null,"hotelStars":null,"imageCategories":[],"imageUrl":"example","imagesCount":25,"isAdvertisement":false,"kgmid":"example","language":"example","locatedIn":null,"location":{"lat":0,"lng":0},"menu":null,"neighborhood":"example","openingHours":[{"day":"Monday","hours":"example"},{"day":"Tuesday","hours":"example"},{"day":"Wednesday","hours":"example"},{"day":"Thursday","hours":"example"},{"day":"Friday","hours":"example"},{"day":"Saturday","hours":"example"},{"day":"Sunday","hours":"Closed"}],"ownerDescription":null,"peopleAlsoSearch":[],"permanentlyClosed":false,"phone":"example","phoneUnformatted":"example","placeId":"example","placesTags":[],"plusCode":null,"popularTimesHistogram":{},"popularTimesLivePercent":null,"popularTimesLiveText":null,"postalCode":"example","price":null,"rank":0,"reserveTableUrl":null,"reviewsCount":213,"reviewsDistribution":{"fiveStar":181,"fourStar":25,"oneStar":3,"threeStar":4,"twoStar":0},"reviewsTags":[],"scrapedAt":"2026-09-30T04:32:43.410Z","searchPageUrl":"example","searchString":"example","servicesLink":null,"state":"example","street":"example","subTitle":"example","temporarilyClosed":false,"title":"example","totalScore":0,"url":"example","wasOpenAtScrapeTime":true,"website":"example"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"base_credits_per_call":0,"credits_per_result":0.1,"result_count_field":"_list_count"}}},"/google_maps_places_scraper_sync_using_url":{"post":{"operationId":"google_maps_places_scraper_sync_using_url","summary":"Google Maps Places (URL)","description":"Scrape Google Maps places directly from a search results URL.","tags":["Maps"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"google_map_search_url":{"type":"string","description":"Google Maps search results URL","pattern":"^https?://(www\\.)?google\\.[a-z.]+/maps/(search|place)/.+$"},"limit":{"type":"integer","description":"Max results to return (default 5, max 300)","default":5}},"required":["google_map_search_url","limit"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"additionalInfo":{"Service options":[{"Dine-in":true}]},"address":"1 Example Street, Springfield, IL 62701, United States","categories":["Coffee shop","Cafe"],"categoryName":"Coffee shop","city":"Springfield","countryCode":"US","description":"A neighborhood coffee shop.","imageUrl":"https://example.com/images/sample.jpg","imagesCount":40,"isAdvertisement":false,"kgmid":"/g/11example0","location":{"lat":39.7817,"lng":-89.6501},"neighborhood":"Downtown","openingHours":[{"day":"Monday","hours":"7 AM to 6 PM"}],"permanentlyClosed":false,"phone":"(555) 010-0000","phoneUnformatted":"+15550100000","placeId":"ChIJexample0000000000000","postalCode":"62701","price":"$$","rank":1,"reviewsCount":120,"searchString":"","state":"Illinois","street":"1 Example Street","subTitle":null,"temporarilyClosed":false,"title":"Example Coffee","totalScore":4.5,"url":"https://www.google.com/maps/place/?q=place_id:ChIJexample0000000000000","website":"https://example.com"}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"_list_count"}}},"/google_maps_reviews_scraper_sync":{"post":{"operationId":"google_maps_reviews_scraper_sync","summary":"Google Maps Reviews","description":"Scrape reviews for a specific Google Maps place synchronously.","tags":["Maps"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"google_map_review_url":{"type":"string","description":"Google Maps place URL to scrape reviews for","pattern":"^https?://(www\\.)?google\\.[a-z.]+/maps/place/.+$"},"limit":{"type":"integer","description":"Maximum number of reviews to return (max 300)","default":5},"review_sort":{"type":"string","description":"Sort order: mostRelevant, newest, highestRanking, lowestRanking","default":"newest","pattern":"^(mostRelevant|newest|highestRanking|lowestRanking)$","enum":["newest","mostRelevant","highestRanking","lowestRanking"]}},"required":["google_map_review_url","limit"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"publishedAtDate":"2024-02-01T10:00:00.000Z","reviewId":"ChZDSUhNMG9nS0VJQ0FnSUNleGFtcGxlEAE","reviewText":"Great coffee and friendly staff.","reviewerName":"Sam Example","stars":5}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"_list_count"}}},"/google_search_scraper_sync":{"post":{"operationId":"google_search_scraper_sync","summary":"Google Search Scraper","description":"Scrape Google Search results synchronously.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search_query":{"type":"string","description":"Search query string"},"limit":{"type":"integer","description":"Maximum number of result pages to fetch (max 100)","default":1}},"required":["search_query"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"hasNextPage":true,"organicResults":[{"description":"An example result description.","displayedUrl":"example.com","position":1,"title":"Example Domain","type":"organic","url":"https://example.com/"}],"searchQuery":{"term":"example query"},"url":"https://www.google.com/search?q=example+query"}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":1,"result_count_field":"_list_count"}}},"/identify_email_type":{"post":{"operationId":"identify_email_type","summary":"Identify Email Type","description":"Classify an email address as personal, business, role-based, or disposable.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address to classify","pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"address":"example@abc.com","domain":"abc.com","email_provider":"Other","guessed_name":"example","is_gmail":false,"is_hotmail":false,"is_icloud":false,"is_likely_company_email":true,"is_likely_education_email":false,"is_likely_personal_email":false,"is_proton":false,"is_yahoo":false,"is_yandex":false,"richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":12345,"status":"charged"},"request_id":"req-0123456789","response_time_ms":1134},"username":"example"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/job_detail":{"post":{"operationId":"job_detail","summary":"Job Details","description":"Get full job details including description, workplace type, and employment type.","tags":["Enrichment"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string","description":"ID of the LinkedIn job (must be an active job)","pattern":"^[0-9]+$"},"url":{"type":"string","description":"URL of the LinkedIn job (alternative to job_id)"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"element":{"applicantTrackingSystem":null,"applicants":200,"applyMethod":{"applyStartersPreferenceVoid":false,"companyApplyUrl":"https://jobsearch.example.com","inPageOffsiteApply":false,"type":"OffsiteApply"},"benefits":[],"benefitsDataSource":"JOB_POSTER","closedAt":null,"company":{"affiliatedPages":[],"backgroundCover":"https://example","backgroundCovers":[{"height":191,"url":"https://example","width":1128}],"callToActionUrl":null,"description":"example","employeeCount":0,"employeeCountRange":{"start":0},"followerCount":0,"id":"01234","industries":[{"hierarchy":null,"id":null,"name":"Motor Vehicle Manufacturing","title":"Motor Vehicle Manufacturing"}],"linkedinUrl":"https://www.linkedin.com/company/example","locations":[{"city":"Saint-Ouen","country":"FR","headquarter":true,"line1":"48, rue Albert Dhalenne","parsed":{"city":"Saint-Ouen","country":"France","countryCode":"FR","countryFull":"France","regionCode":null,"state":"Île-de-France","text":"Saint-Ouen, France"},"postalCode":"93 400"}],"logo":"https://example","logos":[{"height":100,"url":"https://example","width":100}],"name":"example","similarOrganizations":[],"specialities":["Rail vehicles","Rail infrastructure"],"universalName":"example","website":"http://www.example.com"},"contentSource":"JOBS_CREATE","descriptionHtml":"example","descriptionText":"example","easyApplyUrl":null,"employmentType":"full_time","experienceLevel":null,"expireAt":"2026-10-08T07:09:12.000Z","headerCaptionText":"example","hiringTeam":[],"id":"1234567","industries":["Truck Transportation","Railroad Equipment Manufacturing"],"jobApplicationLimitReached":false,"jobFunctions":["PRJM","IT"],"jobState":"LISTED","linkedinUrl":"https://www.linkedin.com/jobs/view/0123456/","location":{"countryCode":"in","geoId":"012","linkedinText":"Mumbai Metropolitan Region","parsed":{"city":"Mumbai","country":"India","countryCode":"IN","countryFull":"India","regionCode":null,"state":"Maharashtra","text":"Mumbai, India"},"postalAddress":null},"new":false,"postedDate":"2026-08-12T07:07:18.000Z","salary":{"max":null,"min":null,"text":null},"title":"example","views":0,"workRemoteAllowed":false,"workplaceType":null},"richapi_meta":{"credits":{"charged":1,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98704.97,"status":"charged"},"request_id":"012345","response_time_ms":4336}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/job_search":{"post":{"operationId":"job_search","summary":"Job Search","description":"Search jobs by title, company, location, and more.","tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"Job title keyword"},"company":{"type":"string","description":"Company name or LinkedIn company URL"},"location":{"type":"string","description":"Location text filter"},"geoId":{"type":"string","description":"LinkedIn Geo ID for precise location filtering","pattern":"^[0-9]+(,[0-9]+)*$"},"jobType":{"type":"string","description":"full_time, part_time, contract, temporary, internship","enum":["full_time","part_time","contract","temporary","internship"]},"experienceLevel":{"type":"string","description":"internship, entry, associate, mid-senior, director, executive","enum":["internship","entry","associate","mid-senior","director","executive"]},"page":{"type":"integer","description":"Page number for pagination","default":1}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"company":{"linkedinUrl":"https://www.linkedin.com/company/example","name":"example","universalName":"example"},"easyApply":false,"id":"1238","location":{"linkedinText":"Mountain View, CA (On-site)"},"postedDate":"2026-09-28T17:37:39.000Z","title":"Researcher, Robot Intelligence","url":"https://www.linkedin.com/jobs/view/1238"}],"pagination":{"pageNumber":1,"pageSize":25,"previousElements":0,"totalElements":228158,"totalPages":9127},"richapi_meta":{"credits":{"charged":2.5,"reason":"Charged for returned results.","reason_code":"per_result","remaining":98791.87,"status":"charged"},"request_id":"req-123456789","response_time_ms":4505}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"elements"}}},"/lead_search":{"post":{"operationId":"lead_search","summary":"Lead Search","description":"Advanced lead search with 30+ filters including seniority, function, geography, company, title, Sales Navigator URL, and exclusion filter support.","tags":["Leads"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"search_query":{"type":"string","description":"Fuzzy keyword search."},"sales_nav_url":{"type":"string","description":"Full LinkedIn Sales Navigator search URL. May be combined with individual filters."},"locations":{"type":"array","description":"Location names"},"geo_ids":{"type":"array","description":"LinkedIn geo IDs or location names"},"seniority":{"type":"array","description":"Seniority labels resolved to LinkedIn seniorityLevelIds."},"functions":{"type":"array","description":"Job function labels resolved to LinkedIn functionIds."},"industries":{"type":"array","description":"Industry labels resolved to LinkedIn industryIds."},"company_size":{"type":"array","description":"Company size ranges."},"years_of_experience":{"type":"array","description":"Experience range labels resolved to LinkedIn yearsOfExperienceIds."},"years_at_current_company":{"type":"array","description":"Tenure range labels resolved to LinkedIn yearsAtCurrentCompanyIds."},"profile_languages":{"type":"array","description":"Profile language labels resolved to language codes."},"current_companies":{"type":"array","description":"Current company LinkedIn URLs or IDs."},"past_companies":{"type":"array","description":"Past company LinkedIn URLs or IDs."},"current_job_titles":{"type":"array","description":"Current job title filters."},"past_job_titles":{"type":"array","description":"Past job title filters."},"first_names":{"type":"array","description":"First name filters."},"last_names":{"type":"array","description":"Last name filters."},"schools":{"type":"array","description":"School LinkedIn URLs or IDs."},"recently_changed_jobs":{"type":"boolean","description":"Filter for people who recently changed jobs."},"company_headquarter_locations":{"type":"array","description":"Company headquarters location filters."},"exclude_seniority":{"type":"array","description":"Seniority labels to exclude."},"exclude_industries":{"type":"array","description":"Industry labels to exclude."},"exclude_functions":{"type":"array","description":"Job function labels to exclude."},"exclude_locations":{"type":"array","description":"Location text values to exclude."},"exclude_geo_ids":{"type":"array","description":"LinkedIn geo IDs or location names to exclude."},"exclude_current_companies":{"type":"array","description":"Current company LinkedIn URLs or IDs to exclude."},"exclude_past_companies":{"type":"array","description":"Past company LinkedIn URLs or IDs to exclude."},"exclude_current_job_titles":{"type":"array","description":"Current job titles to exclude."},"exclude_past_job_titles":{"type":"array","description":"Past job titles to exclude."},"exclude_schools":{"type":"array","description":"School LinkedIn URLs or IDs to exclude."},"exclude_company_headquarter_locations":{"type":"array","description":"Company headquarters locations to exclude."},"page":{"type":"integer","description":"Positive page number for pagination. Defaults to 1.","default":1},"session_id":{"type":"string","description":"Optional unique ID used to keep pagination requests on the same scraping resource. Generate a random string (for example, a UUID) and send the same value with each page request"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"currentPositions":[{"companyName":"example.","current":true,"startedOn":{"month":4,"year":2008},"tenureAtCompany":{"numMonths":6,"numYears":18},"tenureAtPosition":{"numMonths":6,"numYears":18},"title":"Senior Registered Associate"}],"firstName":"person","id":"12345","lastName":"name ","linkedinUrl":"https://www.linkedin.com/in/12345","location":{"linkedinText":"Kirkland, Washington, United States"},"openProfile":false,"premium":false}],"pagination":{"pageNumber":1,"pageSize":25,"previousElements":0,"totalElements":58588098,"totalPages":100},"richapi_meta":{"credits":{"charged":22.5,"reason":"Charged for the base call and returned results.","reason_code":"base_plus_per_result","remaining":1234,"status":"charged"},"request_id":"req-0123456788","response_time_ms":6446},"sessionId":"1234567"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"base_credits_per_call":10,"credits_per_result":0.5,"result_count_field":"elements"}}},"/meta_ads_library_scraper_sync":{"post":{"operationId":"meta_ads_library_scraper_sync","summary":"Meta Ads Library Scraper","description":"Scrape Meta (Facebook/Instagram) Ad Library — get active ads, creatives, spend ranges, and targeting.","tags":["Ads"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"meta_ad_url":{"type":"string","description":"URL of the Meta Ad to scrape","pattern":"^https?://(www\\.)?facebook\\.com/ads/library/.+$"},"limit":{"type":"integer","description":"Max results to return (max 100)","default":0}},"required":["meta_ad_url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"adArchiveID":"1000000000000000","adLibraryURL":"https://www.facebook.com/ads/library/?id=1000000000000000","adStatus":"ACTIVE","adText":"Try Example Corp free for 14 days.","ctaDomain":"example.com","ctaHeadline":"Start your free trial","endDate":null,"languages":["en"],"pageCategory":"Software company","pageCountry":"US","pageInstagramUser":"examplecorp","pageLikes":25000,"pageName":"Example Corp","pageVerified":true,"publisherPlatforms":["FACEBOOK","INSTAGRAM"],"startDate":"2024-01-15"}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":1,"result_count_field":"_list_count"}}},"/normalize_company":{"post":{"operationId":"normalize_company","summary":"Normalize Company","description":"Clean and normalize a company name by removing legal suffixes, extra whitespace, and punctuation.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_name":{"type":"string","description":"Company name to normalize (e.g. ACME TECHNOLOGIES, INC.)"},"normalize_case":{"type":"boolean","description":"Convert to title case (default true)","default":false}},"required":["company_name"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"case_normalized":true,"changes_applied":true,"normalized_name":"abc","original_name":"abc.","removed_suffixes":["Inc."],"richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98788.87,"status":"charged"},"request_id":"req-0123456789","response_time_ms":1147}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/normalize_list":{"post":{"operationId":"normalize_list","summary":"Normalize List","description":"Split a delimited string into a clean list, optionally removing empty values.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string","description":"Delimited string to split and deduplicate"},"remove_empty_values":{"type":"boolean","description":"Remove empty items after splitting (default false)","default":false}},"required":["input"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"deduped_list":["apple","Banana","cherry"],"deduped_string":"apple, Banana, cherry","deduplicated_count":3,"original_count":5}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/normalize_phone":{"post":{"operationId":"normalize_phone","summary":"Normalize Phone","description":"Parse and normalize a phone number to E.164 format with optional country code hint.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number to normalize (any format)"},"country_code":{"type":"string","description":"ISO country code hint (e.g. US)"}},"required":["phone_number"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"can_be_internationally_dialed":true,"country_code":1,"e164_format":"+14155551234","international_format":"+1 415-555-1234","is_possible":true,"is_valid":true,"national_format":"(415) 555-1234","number_type":"FIXED_LINE_OR_MOBILE","region_code":"US","rfc3966_format":"tel:+1-415-555-1234","richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98787.87,"status":"charged"},"request_id":"1789093245","response_time_ms":1165},"successfully_parsed":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/people_search":{"post":{"operationId":"people_search","summary":"People Search","description":"Search B2B profiles by company/account and contact filters such as domain, industry, employee size, job title, and location.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer","description":"Page number, zero-based.","default":0},"limit":{"type":"integer","description":"Number of items per page.","default":10},"linkedin":{"type":"array","description":"LinkedIn account URLs."},"domain":{"type":"array","description":"Company domains."},"industry":{"type":"array","description":"Industry names."},"employee_size_start":{"type":"integer","description":"Minimum employee count."},"employee_size_end":{"type":"integer","description":"Maximum employee count."},"job_title":{"type":"array","description":"Job titles to match."},"location":{"type":"array","description":"Locations to match."}},"required":["limit","page"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"content":[{"awards":[],"background":null,"birthDate":null,"certifications":[],"courses":[],"creator":false,"educations":[],"entityUrn":"123456","firstname":"example","headline":"SDE","hiring":false,"identifier":"example","industry":"Computer Software","influencer":false,"languages":[],"lastname":"S","location":{"city":"Bengaluru","country":"India","defaultValue":"Bengaluru, Karnataka, India, Asia","shortValue":"Bengaluru, Karnataka","state":"Karnataka"},"middleName":null,"networkInfo":{"connectionsCount":9,"followersCount":9},"objectUrn":123,"openToWork":false,"organizations":[],"patents":[],"picture":null,"positionGroups":[{"company":{"employees":{"end":10000,"start":5001},"id":6183,"logo":"https://example","name":"Example","profileType":"COMPANY","url":"https://www.linkedin.com/company/example"},"date":null,"profilePositions":[{"company":"example","date":null,"description":null,"employmentType":null,"location":null,"title":"Senior Engineer"}]}],"premium":false,"projects":[],"publications":[],"recommendations":[],"skills":["ASP.NET Core","Code Review"],"summary":null,"testScores":[],"url":"https://www.linkedin.com/in/example","verified":false,"volunteerExperiences":[]}],"empty":false,"first":true,"last":false,"number":0,"numberOfElements":10,"pageable":{"offset":0,"pageNumber":0,"pageSize":10,"paged":true,"sort":{"empty":true,"sorted":false,"unsorted":true},"unpaged":false},"richapi_meta":{"credits":{"charged":1,"reason":"Charged for returned results.","reason_code":"per_result","remaining":98786.87,"status":"charged"},"request_id":"req-0123456","response_time_ms":2883},"size":10,"sort":{"empty":true,"sorted":false,"unsorted":true},"totalElements":231447498,"totalPages":23144750}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"numberOfElements"}}},"/phone_finder":{"post":{"operationId":"phone_finder","summary":"Phone Finder","description":"Find a mobile phone number using a B2B URL or name and company. Tries multiple providers automatically.","tags":["Enrichment"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"linkedin_url":{"type":"string","description":"LinkedIn profile URL (preferred)","pattern":"^https?://([a-z]{2,3}\\.)?linkedin\\.com/in/[A-Za-z0-9%_\\-.]+/?$"},"first_name":{"type":"string","description":"First name (required if no linkedin_url)"},"last_name":{"type":"string","description":"Last name (required if no linkedin_url)"},"domain":{"type":"string","description":"Company domain (required if no linkedin_url)","pattern":"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"execution_log":[{"latency_ms":342,"provider":"prospeo","status":"success"}],"provider":"prospeo","providers_tried":1,"result":{"phone":"+1 0123456789","phone_status":"VERIFIED"},"richapi_meta":{"credits":{"charged":25,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98678.87,"status":"charged"},"request_id":"012345678912","response_time_ms":1217},"success":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":25}}},"/post_activities":{"post":{"operationId":"post_activities","summary":"Post Activities","description":"Get likes, comments and reactions on a specific B2B post.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urn":{"type":"string","description":"LinkedIn activity URN, e.g. urn:li:activity:7458532524865232896.","pattern":"^urn:li:(?:activity|ugcPost):[0-9]+$"},"type":{"type":"string","description":"Activity type to return: COMMENT or REACTION.","default":"COMMENT","pattern":"^(COMMENT|REACTION)$"},"page":{"type":"integer","description":"Page number, zero-based.","default":0},"limit":{"type":"integer","description":"Number of items per page.","default":10}},"required":["urn"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"content":[{"comment":"Congratulations ","commenter":{"entityUrn":"12345678","firstName":"example","headline":"example","lastName":"name","objectUrn":123,"profileBackground":"https://mediapfp","profileId":"example","profilePicture":"https://mediaexample","profileType":"PERSON"},"id":"urn:li:comment:(ugcPost:1234)","reactionType":{},"totalComments":1,"totalReactions":0,"url":"https://www.linkedin.com/feed/update/urn:li:ugcPost:123456789"}],"empty":false,"first":true,"last":true,"number":0,"numberOfElements":7,"pageable":{"offset":0,"pageNumber":0,"pageSize":10,"paged":true,"sort":{"empty":true,"sorted":false,"unsorted":true},"unpaged":false},"richapi_meta":{"credits":{"charged":3,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98757.87,"status":"charged"},"request_id":"0123456789","response_time_ms":4784},"size":10,"sort":{"empty":true,"sorted":false,"unsorted":true},"totalElements":7,"totalPages":1}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":3}}},"/post_details":{"post":{"operationId":"post_details","summary":"Post Details","description":"Get full post details including text, media, comments and reaction counts.","tags":["Activity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urn":{"type":"string","description":"LinkedIn activity URN e.g. urn:li:activity:7458532524865232896"},"comments":{"type":"boolean","description":"Include comments list in response (default true)","default":false},"reactions":{"type":"boolean","description":"Include reactions list in response (default true)","default":false}},"required":["urn"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"actor":{"entityUrn":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","firstName":"Jane","headline":"Software Engineer at Example Corp","lastName":"Doe","objectUrn":1000000,"profileBackground":"https://example.com/images/sample.jpg","profileId":"janedoe","profilePicture":"https://example.com/images/sample.jpg","profileType":"PERSON"},"commentary":"Example post text.","comments":[{"comment":"Congratulations!","commenter":{"entityUrn":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","firstName":"John","headline":"Software Engineer at Example Corp","lastName":"Smith","objectUrn":1000000,"profileBackground":"https://example.com/images/sample.jpg","profileId":"johnsmith","profilePicture":"https://example.com/images/sample.jpg","profileType":"PERSON"},"id":"urn:li:comment:(ugcPost:7000000000000000000,7000000000000000001)","reactionType":{},"totalComments":0,"totalReactions":0,"url":"https://www.linkedin.com/feed/update/urn:li:ugcPost:7000000000000000000"}],"content":{"article":null,"celebration":null,"document":{"documentUrl":"https://example.com/doc.pdf","expiry":1704067200000,"title":"Example document","totalPages":1},"entity":null,"image":null,"poll":null,"showcase":null,"video":null},"numComments":20,"numReactions":150,"numShares":0,"reactionType":{"like":140,"praise":10},"reactions":[{"reaction":"LIKE","reactor":{"entityUrn":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","firstName":"Alex","headline":"Software Engineer at Example Corp","lastName":"Lee","objectUrn":1000000,"profileBackground":"https://example.com/images/sample.jpg","profileId":"alexlee","profilePicture":"https://example.com/images/sample.jpg","profileType":"PERSON"}}],"shareUrl":"https://www.linkedin.com/posts/janedoe_example-activity-7000000000000000000","shareUrn":"urn:li:ugcPost:7000000000000000000","sponsored":false,"threadUrn":"urn:li:ugcPost:7000000000000000000","urn":"urn:li:activity:7000000000000000000"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/post_keyword_search":{"post":{"operationId":"post_keyword_search","summary":"Post Keyword Search","description":"Search B2B posts by keyword to discover trending content and engagement opportunities.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyword":{"type":"string","description":"Keyword or phrase to search LinkedIn posts for."},"page":{"type":"integer","description":"Page number, zero-based.","default":0},"limit":{"type":"integer","description":"Results per page, 1-50.","default":10},"sort":{"type":"string","description":"Sort order: RELEVANCE or DATE_POSTED.","default":"RELEVANCE","pattern":"^(RELEVANCE|DATE_POSTED)$","enum":["RELEVANCE","DATE_POSTED"]},"datePosted":{"type":"string","description":"Date filter: PAST_24_HOURS, PAST_WEEK, or PAST_MONTH.","pattern":"^(PAST_24_HOURS|PAST_WEEK|PAST_MONTH)$","enum":["PAST_24_HOURS","PAST_WEEK","PAST_MONTH"]},"contentType":{"type":"string","description":"Content type: VIDEO, IMAGE, JOB, LIVE_VIDEO, DOCUMENT, or COLLABORATIVE_ARTICLE.","pattern":"^(VIDEO|IMAGE|JOB|LIVE_VIDEO|DOCUMENT|COLLABORATIVE_ARTICLE)$","enum":["VIDEO","IMAGE","JOB","LIVE_VIDEO","DOCUMENT","COLLABORATIVE_ARTICLE"]},"fromPerson":{"type":"array","description":"Filter by person entity URNs"},"fromCompany":{"type":"array","description":"Filter by company entity URNs"},"authorKeyword":{"type":"array","description":"Filter by author job titles"},"authorIndustry":{"type":"array","description":"Filter by author industry"},"mentionsPerson":{"type":"array","description":"Filter by mentioned person profile entity URNs."},"mentionsCompany":{"type":"array","description":"Filter by mentioned company profile entity URNs, as numeric strings."}},"required":["keyword"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"content":[{"actor":{"entityUrn":"example","firstName":"example","headline":"example","lastName":"example","objectUrn":0,"profileId":"example","profilePicture":"example","profileType":"PERSON"},"commentary":"example","content":{"article":null,"celebration":null,"document":null,"entity":null,"image":null,"poll":{"closed":false,"options":[{"entityUrn":"example","text":"example","votes":0},{"entityUrn":"example","text":"example","votes":0},{"entityUrn":"example","text":"example","votes":0}],"question":"example","votes":0},"showcase":null,"video":null},"numComments":3,"numReactions":2,"numShares":0,"reactionType":{"like":2},"shareUrl":"https://www.example.com/posts/example_0123456789","shareUrn":"urn:li:ugcPost:0123456789","threadUrn":"urn:li:ugcPost:0123456789","urn":"urn:li:activity:0123456789"}],"empty":false,"first":true,"last":false,"number":0,"numberOfElements":2,"pageable":{"offset":0,"pageNumber":0,"pageSize":2,"paged":true,"sort":{"empty":true,"sorted":false,"unsorted":true},"unpaged":false},"richapi_meta":{"credits":{"charged":0.2,"reason":"Charged for returned results.","reason_code":"per_result","remaining":98678.67,"status":"charged"},"request_id":"0123456789","response_time_ms":4184},"size":2,"sort":{"empty":true,"sorted":false,"unsorted":true},"totalElements":366,"totalPages":183}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"numberOfElements"}}},"/predict_gender":{"post":{"operationId":"predict_gender","summary":"Predict Gender","description":"Predict the gender of a person from their first name.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"First name to predict gender for"}},"required":["name"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"count":149418,"gender":"male","name":"example","probability":0.9,"richapi_meta":{"credits":{"charged":1,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98755.87,"status":"charged"},"request_id":"req-0123456789","response_time_ms":1651}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/profile_activities":{"post":{"operationId":"profile_activities","summary":"Profile Activities","description":"Get a profile's recent posts, comments and reactions for engagement analysis.","tags":["Activity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urn":{"type":"string","description":"LinkedIn entity URN of the profile"},"type":{"type":"string","description":"Activity type filter: POST, COMMENT, or REACTION (default: all)","enum":["POST","COMMENT","REACTION"]},"pagination_token":{"type":"string","description":"Token from previous response for next page"},"limit":{"type":"integer","description":"Number of items per page","default":0}},"required":["urn"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"commentCount":1,"likeCount":1,"publishedAt":"example","text":"example","type":"example","url":"example"}]}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":2,"result_count_field":"content"}}},"/profile_search":{"post":{"operationId":"profile_search","summary":"B2B Profile Search","description":"Search profiles by name, title, company, location and more.","tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string","description":"Name to search (supports fuzzy matching)"},"first_name":{"type":"string","description":"Strict first-name filter"},"last_name":{"type":"string","description":"Strict last-name filter"},"title":{"type":"string","description":"Job title filter"},"current_company":{"type":"string","description":"Company ID or LinkedIn URL; comma-separated for multiple"},"past_company":{"type":"string","description":"Past company ID or URL; comma-separated for multiple"},"school":{"type":"string","description":"School ID or URL; comma-separated for multiple"},"location":{"type":"string","description":"Location text (LinkedIn autocomplete)"},"geo_id":{"type":"string","description":"LinkedIn Geo ID — overrides location; use geo_id_search to resolve"},"industry_id":{"type":"string","description":"Industry ID; comma-separated for multiple"},"page":{"type":"integer","description":"Page number for pagination (1-based)","default":1},"follower_of":{"type":"string","description":"Filter profiles following a LinkedIn profile. URL or ID. Comma-separated."},"keywords_company":{"type":"string","description":"Keyword filter on company name"},"keywords_school":{"type":"string","description":"Keyword filter on school name"}}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"elements":[{"hidden":true,"id":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","linkedinUrl":null,"location":{"linkedinText":"Bengaluru"},"name":"LinkedIn Member","photo":"https://example.com/images/sample.jpg","position":"Software Engineer at Example Corp","publicIdentifier":null},{"id":"ACoAAExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","linkedinUrl":"https://www.linkedin.com/in/janedoe","location":{"linkedinText":"Seattle, WA"},"name":"Jane Doe","photo":"https://example.com/images/sample.jpg","position":"Chief Executive Officer at Example Corp","publicIdentifier":"janedoe"}],"pagination":{"pageNumber":1,"pageSize":25,"previousElements":0,"totalElements":2,"totalPages":1,"totalResultCount":2}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":0.1,"result_count_field":"elements"}}},"/profile_social_metrics":{"post":{"operationId":"profile_social_metrics","summary":"Profile Social Metrics","description":"Get B2B profile verification status, follower count, and connection count.","tags":["Enrichment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"LinkedIn profile URL to retrieve social metrics for.","pattern":"^https?://([a-z]{2,3}\\.)?linkedin\\.com/in/[^/?#]+/?(?:[?#].*)?$"},"useCache":{"type":"boolean","description":"Use the provider's cached profile data when available.","default":true}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"connectionsCount":15289,"followersCount":15237,"richapi_meta":{"credits":{"charged":1,"reason":"Charged per successful call.","reason_code":"per_call","remaining":49455.78,"status":"charged"},"request_id":"012345678","response_time_ms":2305},"verified":true}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/remove_whitespace":{"post":{"operationId":"remove_whitespace","summary":"Remove Whitespace","description":"Strip and collapse extra whitespace from a string.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input_text":{"type":"string","description":"String to strip and collapse whitespace from"}},"required":["input_text"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"changes_applied":true,"characters_removed":6,"normalized_length":11,"normalized_text":"hello world","original_length":17,"original_text":"  hello   world  ","richapi_meta":{"credits":{"charged":0.5,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98754.77,"status":"charged"},"request_id":"req-012345789","response_time_ms":1139}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0.5}}},"/search_bing":{"post":{"operationId":"search_bing","summary":"Bing Search","description":"Search Bing and get structured SERP results with titles, URLs, and descriptions.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"Search query string"},"limit":{"type":"integer","description":"Number of results to return (default 10, max 50)","default":0},"page":{"type":"integer","description":"Page number for pagination","default":0}},"required":["limit","query"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"query":"example query","related_searches":["example query ideas"],"results":[{"date_published":null,"description":"An example result description.","displayed_url":"example.com","position":1,"thumbnail":null,"title":"Example Domain","url":"https://example.com/"}],"total_results":1},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/search_google_trends":{"post":{"operationId":"search_google_trends","summary":"Google Trends","description":"Get Google Trends data: interest over time, related queries, and rising queries for any keyword.","tags":["Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyword":{"type":"string","description":"Keyword to fetch trend data for"},"geo":{"type":"string","description":"Country code to filter by (e.g. US, GB); omit for worldwide"},"timeframe":{"type":"string","description":"Time range (e.g. today 12-m, today 5-y); default today 12-m"}},"required":["keyword"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"geo":"US","interest_by_region":[{"region":"California","value":90},{"region":"Texas","value":70}],"keyword":"example keyword","related":[{"query":"example related query","value":90},{"query":"another query","value":40}],"rising":[{"query":"example rising query","value":1500}],"timeframe":"today 12-m","timeline":[{"date":"2024-01-07","value":40},{"date":"2024-01-14","value":60}]},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/search_reference_data":{"post":{"operationId":"search_reference_data","summary":"Search Reference Data","description":"Returns all valid filter labels (seniority levels, industries, functions, etc.) for use with Lead Search.","tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"companySize":["1-10","11-50","51-200"],"functions":["Engineering","Marketing","Sales"],"industries":["Accounting","Banking","Software Development"],"profileLanguages":{"English":"en","French":"fr","German":"de"},"seniority":["CXO","Director","Senior"],"yearsAtCurrentCompany":["Less than 1 year","1 to 2 years","3 to 5 years"],"yearsOfExperience":["Less than 1 year","1 to 2 years","3 to 5 years"]}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":0}}},"/similarweb_scraper_sync":{"post":{"operationId":"similarweb_scraper_sync","summary":"Similarweb Scraper","description":"Scrape Similarweb overview data for one or more domains.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain of the website to analyze (e.g. stripe.com)","pattern":"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"}},"required":["domain"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array"},"example":[{"bounceRate":0.5,"category":"Finance","categoryRank":10,"country":"US","countryRank":100,"countryShare":[{"country":"US","share":0.5},{"country":"GB","share":0.25}],"data_captured_at":"2024-01-01T00:00:00","description":"Example description.","directTraffic":0.4,"domain":"example.com","engagement":{"bounceRate":0.5,"dateFormat":"2024-01-01T00:00:00","month":1,"pagesPerVisit":2.5,"timeOnSite":120.0,"visits":1000000,"year":2024},"monthlyVisits":[{"month":"December 2023","visits":900000},{"month":"January 2024","visits":1000000}],"pagesPerVisit":2.5,"rankGlobal":1200,"referralTraffic":0.2,"relatedApps":[{"icon":"https://example.com/images/sample.jpg","ranking":1,"title":"Example App","type":"IOS","url":"https://example.com/app"}],"searchTraffic":0.3,"searchUrl":"https://example.com","similarSites":[{"categoryRank":5,"description":"Example description.","globalRank":2000,"tags":["payments"],"thumbnail":"https://example.com/images/sample.jpg","title":"Example Org","topCountryRank":500,"totalVisits":800000,"url":"example.org"}],"socialTraffic":0.1,"timeOnSite":120.0,"title":"Example","topKeywords":[{"cpc":1.5,"estimatedValue":5000,"keyword":"example","searchVolume":12000}],"totalVisits":1000000,"type":"overview","url":"https://example.com"}]}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":2,"result_count_field":"_list_count"}}},"/slack_channel_members":{"post":{"operationId":"slack_channel_members","summary":"Slack Channel Members","description":"Extract Slack channel members with names, emails, titles, timezones, admin status. Requires your Slack cookie.","tags":["Social"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"type":"string","description":"Slack workspace subdomain (e.g. acme for acme.slack.com)"},"channel_id":{"type":"string","description":"Slack channel ID (e.g. C0123456789)"},"cookie":{"type":"string","description":"Your Slack xoxd- session cookie"},"token":{"type":"string","description":"Your Slack xoxc- client token"},"max_members":{"type":"integer","description":"Maximum number of members to return","default":0},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["channel_id","cookie","token","workspace"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"channel_id":"C0000000000","members":[{"avatar_url":"https://example.com/images/sample.jpg","display_name":"jane","email":"jane.doe@example.com","is_admin":false,"is_owner":false,"phone":null,"real_name":"Jane Doe","status_text":null,"timezone":"America/Los_Angeles","title":"Engineer","user_id":"U0000000000"}],"total_members":1,"workspace":"example"},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":2}}},"/web_emails":{"post":{"operationId":"web_emails","summary":"Website Email Extractor","description":"Extract email addresses by crawling multiple pages of a website.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Root URL to start crawling from","pattern":"^https?://[^\\s/$.?#].[^\\s]*$"},"max_pages":{"type":"integer","description":"Maximum number of pages to crawl (default 5)","default":1},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"emails":[{"confidence":"medium","email":"user@example.com","source":"contact us page","type":"generic"}],"pages_crawled":2,"pages_scraped_via_firecrawl":1},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":2}}},"/web_json_ld":{"post":{"operationId":"web_json_ld","summary":"JSON-LD Extractor","description":"Extract structured JSON-LD data (Schema.org) from any web page — products, articles, organizations.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Page URL to extract JSON-LD from","pattern":"^https?://[^\\s/$.?#].[^\\s]*$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"count":1,"items":[{"@context":"https://schema.org","@graph":[{"@type":"WebSite","name":"Example","url":"https://example.com/"},{"@type":"Organization","name":"Example","sameAs":["https://www.linkedin.com/company/example"],"url":"https://example.com/"}]}]},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/web_meta_tags":{"post":{"operationId":"web_meta_tags","summary":"Meta Tags Extractor","description":"Extract OpenGraph, Twitter Card, and SEO meta tags from any URL. Returns title, description, images, favicon.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Page URL to extract meta tags from","pattern":"^https?://[^\\s/$.?#].[^\\s]*$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false},"cache_bust":{"type":"boolean","description":"Force fresh fetch, ignoring cache","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"favicon":"https://example.com/favicon.svg","hreflang":[{"lang":"en-US","url":"https://example.com/"},{"lang":"fr-FR","url":"https://example.com/fr"}],"og":{"description":"An example site.","extra":{},"image":"https://example.com/images/sample.jpg","locale":null,"site_name":null,"title":"Example | Home","type":"website","url":"https://example.com/"},"other":{"format-detection":"telephone=no"},"seo":{"author":null,"canonical":"https://example.com/","charset":"utf-8","description":"An example site.","keywords":null,"language":"en-US","robots":null,"title":"Example | Home","viewport":"width=device-width, initial-scale=1"},"twitter":{"card":"summary_large_image","creator":null,"description":"An example site.","extra":{},"image":"https://example.com/images/sample.jpg","site":"@example","title":"Example | Home"}},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/web_pixels":{"post":{"operationId":"web_pixels","summary":"Tracking Pixel Detector","description":"Detect Google Tag Manager, GA4, Facebook Pixel, LinkedIn Insight, TikTok Pixel and more on any site.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Website URL to scan for tracking pixels","pattern":"https?://[^\\s/$.?#].[^\\s]*$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"pixels":{"google_tag_manager":["GTM-XXXXXXX"]},"total_pixels_found":1},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/web_scrape":{"post":{"operationId":"web_scrape","summary":"Web Scraper","description":"Scrape full page HTML and markdown with anti-bot protection via Firecrawl.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL of the page to scrape","pattern":"https?://[^\\s/$.?#].[^\\s]*$"},"formats":{"type":"array","description":"Output formats to include (e.g. html, markdown, links)"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"html":"example","links":[],"markdown":"example","title":"example"},"meta":{"cache_hit":false,"execution_time_ms":430,"quality_warning":null},"richapi_meta":{"credits":{"charged":1,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98745.77,"status":"charged"},"request_id":"req-0123456789","response_time_ms":2772}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/web_sitemap":{"post":{"operationId":"web_sitemap","summary":"Sitemap Extractor","description":"Extract all URLs from a website's sitemap (XML, robots.txt, or crawl discovery).","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Website root URL or direct sitemap URL","pattern":"https?://[^\\s/$.?#].[^\\s]*$"},"limit":{"type":"integer","description":"Maximum number of URLs to return","default":10},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["limit","url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"source":"robots_index","total_count":2,"urls":["https://example.com/legal","https://example.com/pricing"]}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_result":1,"result_count_field":"data.urls"}}},"/web_social_links":{"post":{"operationId":"web_social_links","summary":"Social Links Finder","description":"Find all social media profile links (Facebook, Twitter, LinkedIn, Instagram, YouTube, TikTok, etc).","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Website URL to scan for social links","pattern":"https?://[^\\s/$.?#].[^\\s]*$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"links":{"linkedin":["https://www.linkedin.com/company/example"],"twitter":["https://twitter.com/example"],"youtube":["https://youtube.com/@example"]}},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/web_tech_stack":{"post":{"operationId":"web_tech_stack","summary":"Tech Stack Detector","description":"Detect 100+ technologies (CMS, analytics, CDN, frameworks, payments) + GTM intelligence signals.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Website URL to analyze","pattern":"https?://[^\\s/$.?#].[^\\s]*$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"categories_count":{"Framework":1,"Web Server":1},"gtm_signals":{"buying_signals":["E-commerce platform - direct revenue from website"],"company_stage":"startup","estimated_monthly_tech_spend":0,"tools_by_function":{"payments":["Example Payments"]}},"summary":"Next.js + Nginx","technologies":[{"category":"Framework","confidence":1,"name":"Next.js"},{"category":"Web Server","confidence":1,"name":"Nginx"}]},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/website_intelligence":{"post":{"operationId":"website_intelligence","summary":"Website Intelligence","description":"Flagship: comprehensive website report — meta tags, tech stack, pixels, social links, emails, SSL, headers in one call.","tags":["Web Scraping"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Website URL to analyze","pattern":"https?://[^\\s/$.?#].[^\\s]*$"},"modules":{"type":"array","description":"Specific modules to run (defaults to all). Options: meta_tags, json_ld, pixels, tech_stack, social_links, emails, ssl, headers"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"content_length_bytes":120000,"dns":{"a_records":["192.0.2.1"],"email_provider":null,"mx_records":[]},"emails":{"emails":["user@example.com"]},"final_url":"https://example.com","headers":{"csp":true,"hsts":true,"permissions_policy":false,"referrer_policy":"no-referrer-when-downgrade","security_score":60,"x_content_type_options":"nosniff","x_frame_options":"SAMEORIGIN","x_xss_protection":null},"http_status":200,"json_ld":{"count":1,"items":[{"@context":"https://schema.org","@graph":[{"@type":"WebSite","name":"Example","url":"https://example.com/"},{"@type":"Organization","name":"Example","sameAs":["https://www.linkedin.com/company/example"],"url":"https://example.com/"}]}]},"meta_tags":{"favicon":"https://example.com/favicon.svg","hreflang":[{"lang":"en-US","url":"https://example.com/"},{"lang":"fr-FR","url":"https://example.com/fr"}],"og":{"description":"An example site.","extra":{},"image":"https://example.com/images/sample.jpg","locale":null,"site_name":null,"title":"Example | Home","type":"website","url":"https://example.com/"},"other":{"format-detection":"telephone=no"},"seo":{"author":null,"canonical":"https://example.com/","charset":"utf-8","description":"An example site.","keywords":null,"language":"en-US","robots":null,"title":"Example | Home","viewport":"width=device-width, initial-scale=1"},"twitter":{"card":"summary_large_image","creator":null,"description":"An example site.","extra":{},"image":"https://example.com/images/sample.jpg","site":"@example","title":"Example | Home"}},"page_load_time_ms":800.0,"pixels":{"pixels":{},"total_pixels_found":0},"redirect_chain":[],"seo_issues":["Description too short","Missing robots meta tag"],"seo_score":70,"social_links":{"links":{"linkedin":["https://www.linkedin.com/company/example"],"twitter":["https://twitter.com/example"],"youtube":["https://youtube.com/@example"]},"total_links_found":3},"ssl":{"days_until_expiry":90,"expires":"2025-01-01","grade":"A","issuer":"Example CA"},"tech_stack":{"categories_count":{"Framework":1,"Web Server":1},"gtm_signals":{"buying_signals":["E-commerce platform - direct revenue from website"],"company_stage":"startup","estimated_monthly_tech_spend":0,"tools_by_function":{"payments":["Example Payments"]}},"technologies":[{"category":"Framework","confidence":1,"name":"Next.js"},{"category":"Web Server","confidence":1,"name":"Nginx"}]},"url":"https://example.com"},"meta":{"cache_hit":false,"execution_time_ms":1200,"modules_failed":[],"modules_run":["meta_tags","tech_stack","emails","social_links","pixels","json_ld","headers","dns","ssl"]}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":5}}},"/youtube_channel":{"post":{"operationId":"youtube_channel","summary":"YouTube Channel Info","description":"Get channel info: name, subscriber count, description, avatar, banner, external links.","tags":["YouTube"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"YouTube channel URL (@handle, /c/, or /channel/ format)","pattern":"^https?://(www\\.)?youtube\\.com/(@[A-Za-z0-9_.-]+|c/[A-Za-z0-9_.-]+|channel/[A-Za-z0-9_-]+|user/[A-Za-z0-9_.-]+)(/.*)?$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"avatar_url":"https://example.com/images/sample.jpg","banner_url":"https://example.com/images/sample.jpg","channel_id":"UCxxxxxxxxxxxxxxxxxxxxxx","country":"","description":"Example channel description.","joined_date":"","links":[],"name":"Example Channel","subscriber_count":"25000","video_count":0,"view_count":0},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/youtube_channel_videos":{"post":{"operationId":"youtube_channel_videos","summary":"YouTube Channel Videos","description":"List up to 50 most recent videos from a YouTube channel with titles, view counts, and durations per call.","tags":["YouTube"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"YouTube channel URL","pattern":"^https?://(www\\.)?youtube\\.com/(@[A-Za-z0-9_.-]+|c/[A-Za-z0-9_.-]+|channel/[A-Za-z0-9_-]+|user/[A-Za-z0-9_.-]+)(/.*)?$"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"channel":"example","total_count":50,"videos":[{"duration":120,"publish_date":"","thumbnail":"https://example","title":"example","video_id":"1345","view_count":null}]},"meta":{"cache_hit":false,"execution_time_ms":1846,"quality_warning":null},"richapi_meta":{"credits":{"charged":2,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98725.77,"status":"charged"},"request_id":"req-0123456789","response_time_ms":4188}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":2}}},"/youtube_search":{"post":{"operationId":"youtube_search","summary":"YouTube Search","description":"Search YouTube videos — returns up to 20 video IDs, titles, channels, view counts, and thumbnails per call.","tags":["YouTube"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"Search query"},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["query"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"results":[{"channel":"example","channel_id":"123456","description":"example","duration":123,"publish_date":"2022-01-01","thumbnail":"example","title":"example","video_id":"123456","view_count":123456}]},"meta":{"cache_hit":false,"execution_time_ms":1957,"quality_warning":null},"richapi_meta":{"credits":{"charged":1,"reason":"Charged per successful call.","reason_code":"per_call","remaining":98724.77,"status":"charged"},"request_id":"req-123456789","response_time_ms":4298}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/youtube_video":{"post":{"operationId":"youtube_video","summary":"YouTube Video Details","description":"Get full video details: title, description, view/like counts, duration, tags, thumbnails, chapters.","tags":["YouTube"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"YouTube video URL or video ID","pattern":"^https?://(www\\.)?(youtube\\.com/(watch\\?v=|embed/|v/)|youtu\\.be/)[A-Za-z0-9_-]{11}([?&].*)?$"},"include_captions":{"type":"boolean","description":"Include video captions/subtitles in the response","default":false},"cache":{"type":"boolean","description":"Use cached data if available","default":false}},"required":["url"]}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"additionalProperties":true},"example":{"data":{"captions":null,"categories":["Music"],"channel":"Example Channel","channel_id":"UCxxxxxxxxxxxxxxxxxxxxxx","chapters":[],"description":"Example video description.","duration":120,"like_count":25000,"tags":["example","demo"],"thumbnails":[{"height":360,"url":"https://example.com/images/sample.jpg","width":640},{"height":null,"url":"https://example.com/images/sample.jpg","width":null}],"title":"Example Video Title","upload_date":"20240101","video_id":"xxxxxxxxxxx","view_count":1000000},"meta":{"cache_hit":false,"execution_time_ms":250,"quality_warning":null}}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}],"x-pricing":{"credits_per_call":1}}},"/my-endpoints":{"get":{"operationId":"my_endpoints","summary":"My endpoints","description":"List the endpoints available to the supplied API key.","tags":["Getting Started"],"responses":{"200":{"description":"The API key's available endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"rate_tier":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/MyEndpoint"}},"total":{"type":"integer"}},"required":["rate_tier","endpoints","total"]}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}]}},"/usage":{"get":{"operationId":"usage","summary":"Usage","description":"Return the supplied API key's team-wide credit consumption and current balance.","tags":["Credits & Pricing"],"parameters":[{"name":"month","in":"query","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}$"}},{"name":"months","in":"query","schema":{"type":"integer","minimum":1,"maximum":12}},{"name":"include_previous","in":"query","schema":{"type":"boolean"}},{"name":"start_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"include","in":"query","schema":{"type":"string","enum":["history"]}},{"name":"history_limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"sort_by","in":"query","schema":{"type":"string","enum":["credits","calls","name"]}},{"name":"order","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":0}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"Usage totals for the selected period.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}},"4XX":{"description":"Client error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"API Key":[]}]}}},"components":{"securitySchemes":{"API Key":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"EndpointPricing":{"type":"object","description":"The API key's effective, customer-safe price for this endpoint.","properties":{"credits_per_call":{"type":"number"},"credits_per_result":{"type":"number"},"base_credits_per_call":{"type":"number"},"result_count_field":{"type":"string"},"min_credits_per_call":{"type":"number"},"max_credits_per_call":{"type":"number"},"conditional_components":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"field":{"type":"string"},"equals":{}}},"credits_per_call":{"type":"number"},"description":{"type":"string"}}}}},"additionalProperties":false},"ErrorResponse":{"type":"object","description":"Every error response is a flat JSON object with an `error` string describing what went wrong, plus extra fields specific to that failure — see the endpoint description or the Error Handling section above for examples.","properties":{"error":{"type":"string"},"richapi_meta":{"$ref":"#/components/schemas/RichAPIMeta"}},"required":["error"],"additionalProperties":true},"MyEndpoint":{"type":"object","properties":{"name":{"type":"string"},"pricing":{"$ref":"#/components/schemas/EndpointPricing"},"status":{"type":"string","enum":["active","maintenance"]},"display_name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"request_schema":{"type":"array","items":{}},"input_schema":{"type":"array","items":{}},"example_response":{"oneOf":[{"type":"object"},{"type":"array"}]}},"required":["name","pricing","status","request_schema","input_schema","example_response"],"additionalProperties":false},"RichAPIMeta":{"type":"object","description":"Request timing and credit outcome metadata.","properties":{"request_id":{"type":"string","description":"Correlation id for this request."},"response_time_ms":{"type":"integer","minimum":0},"credits":{"type":"object","properties":{"charged":{"type":["number","null"],"description":"Final credits charged; `null` while settlement is pending."},"remaining":{"type":["number","null"],"description":"Effective team credit balance after this outcome, when available."},"status":{"type":"string","enum":["charged","not_charged","pending"]},"reason_code":{"type":"string","description":"Stable billing outcome code. Clients must tolerate new values."},"reason":{"type":"string","description":"Customer-readable billing explanation."},"estimated_charge":{"type":"number","description":"Estimated credits reserved for a pending request only."}},"required":["charged","remaining","status","reason_code","reason"]}},"required":["request_id","response_time_ms","credits"]},"UsageResponse":{"type":"object","properties":{"months":{"type":"array","items":{"type":"string"}},"total_credits":{"type":"number"},"total_cost":{"type":"number"},"credit_value":{"type":"number"},"total_records":{"type":"integer"},"apis":{"type":"object","additionalProperties":{"type":"object"}},"credits_by_category":{"type":"object","additionalProperties":{"type":"number"}},"credits_remaining":{"type":["number","null"]},"monthly_breakdown":{"type":"object","additionalProperties":{"type":"object"}},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"history":{"type":"array","items":{"type":"object"}},"history_count":{"type":"integer"},"pagination":{"type":"object","properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"total_records":{"type":"integer"},"current_count":{"type":"integer"},"has_more":{"type":"boolean"}},"required":["limit","offset","total_records","current_count","has_more"]}},"required":["months","total_credits","total_cost","credit_value","total_records","apis","credits_by_category","credits_remaining"]}}}}