{
  "openapi": "3.1.0",
  "info": {
    "title": "LurkAPI",
    "version": "1.0.0",
    "description": "Public social media data as clean JSON: one GET request per call, authenticated with the `x-api-key` header. Docs: https://lurkapi.com/docs"
  },
  "servers": [
    {
      "url": "https://api.lurkapi.com"
    }
  ],
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "name": "Facebook",
      "description": "Public Pages and profiles with their contact details, posts, events and comments, plus the ads in Meta's Ad Library."
    },
    {
      "name": "Reddit",
      "description": "Posts, comments, search and community stats from any public subreddit."
    },
    {
      "name": "YouTube",
      "description": "Videos, Shorts, transcripts, comments and channel stats from any public YouTube channel."
    },
    {
      "name": "TikTok",
      "description": "Profiles, videos, transcripts and comments from any public TikTok account."
    },
    {
      "name": "Google",
      "description": "Google Maps places and reviews, Google News, search suggestions, and the ads in Google's Ads Transparency Center."
    },
    {
      "name": "Bluesky",
      "description": "Profiles, posts and full threads from any public Bluesky account."
    },
    {
      "name": "Snapchat",
      "description": "Public profiles, live stories, highlights and Spotlight videos from Snapchat."
    },
    {
      "name": "Truth Social",
      "description": "Profiles and posts from public Truth Social accounts."
    },
    {
      "name": "Telegram",
      "description": "Public channel profiles, their posts and single posts, with views, media and reactions."
    },
    {
      "name": "X (Twitter)",
      "description": "Tweets, profiles and recent posts from any public X account."
    },
    {
      "name": "Threads",
      "description": "Public Threads profiles, an account's posts and single posts, with text, media and engagement."
    },
    {
      "name": "Instagram",
      "description": "Public profiles, posts, reels and comments with media and engagement counts, plus reel search, similar accounts and reel transcripts."
    },
    {
      "name": "LinkedIn",
      "description": "Public profiles, company pages and their updates, job listings, and ads from LinkedIn's Ad Library."
    },
    {
      "name": "Link-in-bio",
      "description": "A creator's Linktree page: their links, social accounts and listed email."
    },
    {
      "name": "eBay",
      "description": "eBay search results and listing details: prices, bids, condition, sellers, shipping and item specifics."
    },
    {
      "name": "Web",
      "description": "Any public web page as HTML, markdown or plain text, even past bot checks and captchas."
    },
    {
      "name": "Account",
      "description": "Your LurkAPI credit balance."
    }
  ],
  "paths": {
    "/v1/facebook/adLibrary/search/ads": {
      "get": {
        "operationId": "facebook_search_ads",
        "tags": [
          "Facebook"
        ],
        "summary": "Search Ad Library ads",
        "description": "Find ads in Meta's Ad Library by keyword, with their copy, media, landing page and run dates.\n\nUse it to see how a whole market advertises: the angles, offers and formats that keep running. For one advertiser's ads, use company ads (facebook_company_ads) instead. Stopped ads are included unless you pass `status=active`.\n\nIt searches every ad in Meta's Ad Library, the same as typing into the search box at facebook.com/ads/library. Filter by country, status, format, language and date range. The most-seen ads come first by default.\n\n**Pagination.** The first page has up to 30 ads and `searchResultsCount`, the estimated total. For more, pass `cursor` back with the same filters. Later pages have up to 10 ads (Facebook's own page size), and `searchResultsCount` is null there. `cursor` is null on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/search-ads"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Keywords to search ad text for, e.g. `running shoes`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "description": "Keywords to search ad text for, e.g. `running shoes`."
            },
            "example": "running shoes"
          },
          {
            "name": "search_type",
            "in": "query",
            "required": false,
            "description": "`keyword_unordered` matches all words in any order; `keyword_exact_phrase` matches the phrase as typed.",
            "schema": {
              "description": "`keyword_unordered` matches all words in any order; `keyword_exact_phrase` matches the phrase as typed.",
              "default": "keyword_unordered",
              "type": "string",
              "enum": [
                "keyword_unordered",
                "keyword_exact_phrase"
              ]
            }
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "The country the ad ran in, as a 2-letter code (US, GB, DE…), or ALL for every country. One country per request.",
            "schema": {
              "description": "The country the ad ran in, as a 2-letter code (US, GB, DE…), or ALL for every country. One country per request.",
              "default": "ALL",
              "type": "string",
              "pattern": "^(ALL|[A-Z]{2})$"
            },
            "example": "US"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only ads that are running now (active), only stopped ads (inactive), or both (all).",
            "schema": {
              "description": "Only ads that are running now (active), only stopped ads (inactive), or both (all).",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "active",
                "inactive"
              ]
            },
            "example": "active"
          },
          {
            "name": "media_type",
            "in": "query",
            "required": false,
            "description": "Ad format. `meme` is Facebook's name for an image with text. `none` means text-only ads.",
            "schema": {
              "description": "Ad format. `meme` is Facebook's name for an image with text. `none` means text-only ads.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "image",
                "video",
                "meme",
                "image_and_meme",
                "none"
              ]
            }
          },
          {
            "name": "ad_type",
            "in": "query",
            "required": false,
            "description": "Ad category. Political and issue ads also show spend and impression ranges.",
            "schema": {
              "description": "Ad category. Political and issue ads also show spend and impression ranges.",
              "default": "ALL",
              "type": "string",
              "enum": [
                "ALL",
                "POLITICAL_AND_ISSUE_ADS",
                "EMPLOYMENT_ADS",
                "HOUSING_ADS",
                "CREDIT_ADS"
              ]
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Language of the ad text as an ISO 639-1 code, e.g. `en` or `es`.",
            "schema": {
              "description": "Language of the ad text as an ISO 639-1 code, e.g. `en` or `es`.",
              "type": "string",
              "pattern": "^([a-z]{2}|cmn|yue)$"
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "description": "`total_impressions` puts the most-seen ads first. `relevancy_monthly_grouped` puts the newest first.",
            "schema": {
              "description": "`total_impressions` puts the most-seen ads first. `relevancy_monthly_grouped` puts the newest first.",
              "default": "total_impressions",
              "type": "string",
              "enum": [
                "total_impressions",
                "relevancy_monthly_grouped"
              ]
            }
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "description": "Only ads shown on or after this date (YYYY-MM-DD). The ad itself may have launched earlier.",
            "schema": {
              "description": "Only ads shown on or after this date (YYYY-MM-DD). The ad itself may have launched earlier.",
              "type": "string"
            }
          },
          {
            "name": "end_date",
            "in": "query",
            "required": false,
            "description": "Only ads shown on or before this date (YYYY-MM-DD).",
            "schema": {
              "description": "Only ads shown on or before this date (YYYY-MM-DD).",
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page. Keep every other param the same.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page. Keep every other param the same.",
              "type": "string"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "`true` leaves out image and video URLs, including those in `snapshot.cards`, for a much smaller response. All text stays.",
            "schema": {
              "description": "`true` leaves out image and video URLs, including those in `snapshot.cards`, for a much smaller response. All text stays.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Find ads in Meta's Ad Library by keyword, with their copy, media, landing page and run dates.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "searchResults": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "ad_archive_id": {
                            "description": "The Ad Library id. Pass it as `id` to the ad details endpoint.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "ad_id": {
                            "description": "Meta's internal ad id. null in every response we've seen; use the Ad Library id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "page_id": {
                            "description": "The advertiser's Facebook page id. Pass it as `pageId` to the company ads endpoint.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "page_name": {
                            "description": "The advertiser's page name.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "is_active": {
                            "type": "boolean",
                            "description": "Whether the ad is running now."
                          },
                          "start_date": {
                            "description": "The day the ad started running, as Unix seconds at midnight Pacific time.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "end_date": {
                            "description": "The day the ad stopped, or its latest delivery day if still running, as Unix seconds at midnight Pacific time.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "start_date_string": {
                            "description": "The same date as ISO 8601 text when Facebook includes it; null in every response we've seen, so use the Unix seconds field.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "end_date_string": {
                            "description": "The same date as ISO 8601 text when Facebook includes it; null in every response we've seen, so use the Unix seconds field.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "total_active_time": {
                            "description": "Seconds the ad has run, when Facebook reports it; usually null.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "publisher_platform": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Where it ran, uppercase: FACEBOOK, INSTAGRAM, AUDIENCE_NETWORK, MESSENGER, THREADS."
                          },
                          "collation_count": {
                            "description": "How many near-identical versions are grouped under this ad. A high count means the advertiser is scaling it; null for a single version.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "collation_id": {
                            "description": "Id shared by the grouped versions of this ad; null for a single version.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "snapshot": {
                            "type": "object",
                            "properties": {
                              "page_id": {
                                "description": "The advertiser's page id (same as the ad's).",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_name": {
                                "description": "The advertiser's page name as shown on the ad.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_profile_uri": {
                                "description": "The advertiser's Facebook page URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_profile_picture_url": {
                                "description": "The advertiser's profile picture, 60×60 px.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_like_count": {
                                "description": "Followers of the advertiser's page.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "page_categories": {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                },
                                "description": "Page categories, e.g. [\"Outdoor & Sporting Goods Company\"]."
                              },
                              "page_is_deleted": {
                                "type": "boolean",
                                "description": "Whether the advertiser's page has been deleted."
                              },
                              "title": {
                                "description": "Headline under the creative; null when there is none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "caption": {
                                "description": "Display link under the creative, usually the domain (e.g. HOKA.com).",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "link_url": {
                                "description": "Landing page the ad sends people to, UTM tags included.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "link_description": {
                                "description": "Text under the headline; null when there is none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cta_text": {
                                "description": "Button label, e.g. \"Shop now\".",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cta_type": {
                                "description": "Button type, e.g. SHOP_NOW, LEARN_MORE, NO_BUTTON.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "display_format": {
                                "description": "Creative format, e.g. IMAGE, VIDEO, DCO (dynamic creative), DPA (dynamic product ad) or MULTI_IMAGES. For DCO and DPA ads the creative is in `cards`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "images": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "original_image_url": {
                                      "description": "Full-size image URL. Facebook's links expire after a few days, so download what you need.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "resized_image_url": {
                                      "description": "600 px image URL, good for thumbnails.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_resized_image_url": {
                                      "type": "string",
                                      "description": "Watermarked copy; empty or null in every response we've seen."
                                    },
                                    "image_crops": {
                                      "type": "array",
                                      "items": {},
                                      "description": "Facebook internal field; an empty array in every response we've seen. Crop hints for the image."
                                    }
                                  },
                                  "required": [
                                    "original_image_url",
                                    "resized_image_url",
                                    "watermarked_resized_image_url",
                                    "image_crops"
                                  ],
                                  "additionalProperties": false
                                },
                                "description": "Image creatives. Empty for video and card-based ads, and with trim=true."
                              },
                              "videos": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "video_hd_url": {
                                      "description": "HD video file URL; null if Facebook has no HD version.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_sd_url": {
                                      "description": "SD video file URL.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_preview_image_url": {
                                      "description": "Poster frame (still image) URL.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_hd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_sd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "video_hd_url",
                                    "video_sd_url",
                                    "video_preview_image_url",
                                    "watermarked_video_hd_url",
                                    "watermarked_video_sd_url"
                                  ],
                                  "additionalProperties": false
                                },
                                "description": "Video creatives. Empty for image and card-based ads, and with trim=true."
                              },
                              "cards": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "title": {
                                      "description": "This version's headline.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "body": {
                                      "description": "This version's primary text.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "caption": {
                                      "description": "This version's display link, usually the domain.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "cta_text": {
                                      "description": "Button label, e.g. \"Shop now\".",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "cta_type": {
                                      "description": "Button type, e.g. SHOP_NOW, LEARN_MORE.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "link_url": {
                                      "description": "This version's landing page URL.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "link_description": {
                                      "description": "Text under the headline; null when there is none.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "original_image_url": {
                                      "description": "Full-size image URL; null for video versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "resized_image_url": {
                                      "description": "600 px image URL; null for video versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_resized_image_url": {
                                      "type": "string",
                                      "description": "Watermarked copy; empty or null in every response we've seen."
                                    },
                                    "image_crops": {
                                      "type": "array",
                                      "items": {},
                                      "description": "Facebook internal field; an empty array in every response we've seen. Crop hints for the image."
                                    },
                                    "video_hd_url": {
                                      "description": "HD video file URL; null for image versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_sd_url": {
                                      "description": "SD video file URL; null for image versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_preview_image_url": {
                                      "description": "Poster frame URL; null for image versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_hd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_sd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "title",
                                    "body",
                                    "caption",
                                    "cta_text",
                                    "cta_type",
                                    "link_url",
                                    "link_description",
                                    "original_image_url",
                                    "resized_image_url",
                                    "watermarked_resized_image_url",
                                    "image_crops",
                                    "video_hd_url",
                                    "video_sd_url",
                                    "video_preview_image_url",
                                    "watermarked_video_hd_url",
                                    "watermarked_video_sd_url"
                                  ],
                                  "additionalProperties": false
                                },
                                "description": "Carousel, dynamic-creative and product versions, each with its own copy and media. With trim=true the text stays and media URLs are null."
                              },
                              "byline": {
                                "description": "Who paid for the ad (the \"Paid for by\" name) on political and issue ads; null on most others.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "disclaimer_label": {
                                "description": "The disclaimer kind on political and issue ads, e.g. PAID_FOR_BY (the name is in `byline`); null otherwise.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "country_iso_code": {
                                "description": "Facebook internal field; null in every response we've seen. A country code on some ads.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "is_reshared": {
                                "type": "boolean",
                                "description": "Whether the ad reshares an existing post (see `root_reshared_post`)."
                              },
                              "root_reshared_post": {
                                "description": "The original post when `is_reshared` is true; null otherwise."
                              },
                              "branded_content": {
                                "description": "Paid partnership details when the ad is branded content; null otherwise."
                              },
                              "additional_info": {
                                "description": "Facebook internal field; null in every response we've seen."
                              },
                              "brazil_tax_id": {
                                "description": "Advertiser tax id shown on ads under Brazil's rules; null otherwise."
                              },
                              "ec_certificates": {
                                "type": "array",
                                "items": {},
                                "description": "Facebook internal field; an empty array in every response we've seen."
                              },
                              "event": {
                                "description": "Event details on event ads; null otherwise."
                              },
                              "extra_images": {
                                "type": "array",
                                "items": {},
                                "description": "More images from dynamic creative; usually empty."
                              },
                              "extra_links": {
                                "type": "array",
                                "items": {},
                                "description": "More landing page URLs from dynamic creative; usually empty."
                              },
                              "extra_texts": {
                                "type": "array",
                                "items": {},
                                "description": "More text variations from dynamic creative; usually empty."
                              },
                              "extra_videos": {
                                "type": "array",
                                "items": {},
                                "description": "More videos from dynamic creative; usually empty."
                              },
                              "body": {
                                "anyOf": [
                                  {
                                    "type": "object",
                                    "properties": {
                                      "text": {
                                        "description": "The ad's primary text.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "text"
                                    ],
                                    "additionalProperties": false
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "Primary text as `{ text }`; null when the copy is only in `cards`."
                              }
                            },
                            "required": [
                              "page_id",
                              "page_name",
                              "page_profile_uri",
                              "page_profile_picture_url",
                              "page_like_count",
                              "page_categories",
                              "page_is_deleted",
                              "title",
                              "caption",
                              "link_url",
                              "link_description",
                              "cta_text",
                              "cta_type",
                              "display_format",
                              "images",
                              "videos",
                              "cards",
                              "byline",
                              "disclaimer_label",
                              "country_iso_code",
                              "is_reshared",
                              "root_reshared_post",
                              "branded_content",
                              "additional_info",
                              "brazil_tax_id",
                              "ec_certificates",
                              "event",
                              "extra_images",
                              "extra_links",
                              "extra_texts",
                              "extra_videos",
                              "body"
                            ],
                            "additionalProperties": false,
                            "description": "The creative: copy, media, landing page and advertiser details."
                          },
                          "categories": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Special ad categories Facebook assigned. [\"UNKNOWN\"] for ordinary ads."
                          },
                          "targeted_or_reached_countries": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Countries the ad targeted or reached, when Facebook discloses them; empty in most results."
                          },
                          "currency": {
                            "type": "string",
                            "description": "Currency code of `spend` (e.g. USD) when spend is reported; an empty string otherwise."
                          },
                          "spend": {
                            "description": "Spend range as Facebook shows it, e.g. \"$600K - $700K\" or \">$1M\" (see `currency`). Political and issue ads only; null otherwise."
                          },
                          "impressions_with_index": {
                            "type": "object",
                            "properties": {
                              "impressions_text": {
                                "description": "The range as Facebook shows it; null when not reported.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "impressions_index": {
                                "type": "number",
                                "description": "Facebook's bucket number for the range; -1 when not reported. Ad details usually omit it."
                              }
                            },
                            "required": [
                              "impressions_text",
                              "impressions_index"
                            ],
                            "additionalProperties": false,
                            "description": "Impressions range, reported for political and issue ads only."
                          },
                          "reach_estimate": {
                            "description": "Estimated reach as Facebook shows it, e.g. \">1M\", on political and issue ads and some EU-delivered ads; null otherwise."
                          },
                          "url": {
                            "description": "Ad Library link for this ad. null in every response we've seen; build it as https://www.facebook.com/ads/library/?id=<Ad Library id>.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "contains_digital_created_media": {
                            "type": "boolean",
                            "description": "Whether Facebook labels the creative as AI-generated or digitally altered."
                          },
                          "contains_sensitive_content": {
                            "type": "boolean",
                            "description": "Facebook internal field; false in every response we've seen. Facebook's sensitive-content flag."
                          },
                          "gated_type": {
                            "type": "string",
                            "description": "Facebook internal field; ELIGIBLE (lowercase in ad details) in every response we've seen."
                          },
                          "has_user_reported": {
                            "type": "boolean",
                            "description": "Whether the viewer reported the ad. Always false, since we read the Ad Library logged out."
                          },
                          "hide_data_status": {
                            "type": "string",
                            "description": "Facebook internal field; NONE in every response we've seen."
                          },
                          "is_aaa_eligible": {
                            "type": "boolean",
                            "description": "Facebook flag, true on a few ads; meaning undocumented. Ad details' `aaa_info` holds the related data when present."
                          },
                          "menu_items": {
                            "type": "array",
                            "items": {},
                            "description": "Facebook internal field; an empty array in every response we've seen."
                          },
                          "page_is_deleted": {
                            "type": "boolean",
                            "description": "Whether the advertiser's page has been deleted."
                          },
                          "regional_regulation_data": {
                            "type": "object",
                            "properties": {
                              "finserv": {
                                "type": "object",
                                "properties": {
                                  "is_deemed_finserv": {
                                    "type": "boolean",
                                    "description": "Facebook treats the ad as a financial-services ad."
                                  },
                                  "is_limited_delivery": {
                                    "type": "boolean",
                                    "description": "Delivery is limited under financial-services rules."
                                  }
                                },
                                "required": [
                                  "is_deemed_finserv",
                                  "is_limited_delivery"
                                ],
                                "additionalProperties": false,
                                "description": "Financial-services ad rules."
                              },
                              "tw_anti_scam": {
                                "type": "object",
                                "properties": {
                                  "is_limited_delivery": {
                                    "type": "boolean",
                                    "description": "Delivery is limited under Taiwan's anti-scam rules."
                                  }
                                },
                                "required": [
                                  "is_limited_delivery"
                                ],
                                "additionalProperties": false,
                                "description": "Taiwan's anti-scam ad rules."
                              }
                            },
                            "required": [
                              "finserv",
                              "tw_anti_scam"
                            ],
                            "additionalProperties": false,
                            "description": "Delivery limits under regional ad rules."
                          },
                          "report_count": {
                            "description": "Times the ad was reported, when disclosed; null in every response we've seen.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "fev_info": {
                            "description": "Facebook internal field; null in every response we've seen."
                          },
                          "state_media_run_label": {
                            "description": "Label for ads run by state-controlled media; null otherwise."
                          }
                        },
                        "required": [
                          "ad_archive_id",
                          "ad_id",
                          "page_id",
                          "page_name",
                          "is_active",
                          "start_date",
                          "end_date",
                          "start_date_string",
                          "end_date_string",
                          "total_active_time",
                          "publisher_platform",
                          "collation_count",
                          "collation_id",
                          "snapshot",
                          "categories",
                          "targeted_or_reached_countries",
                          "currency",
                          "spend",
                          "impressions_with_index",
                          "reach_estimate",
                          "url",
                          "contains_digital_created_media",
                          "contains_sensitive_content",
                          "gated_type",
                          "has_user_reported",
                          "hide_data_status",
                          "is_aaa_eligible",
                          "menu_items",
                          "page_is_deleted",
                          "regional_regulation_data",
                          "report_count",
                          "fev_info",
                          "state_media_run_label"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching ads."
                    },
                    "searchResultsCount": {
                      "description": "Total matching ads, as Facebook estimates it. Only on the first page; null on cursor pages.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "searchResults",
                    "searchResultsCount",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/adLibrary/company/ads": {
      "get": {
        "operationId": "facebook_company_ads",
        "tags": [
          "Facebook"
        ],
        "summary": "Ad Library ads by company",
        "description": "Every ad one advertiser is running (or ran) on Facebook and Instagram, from Meta's Ad Library.\n\nUse it to study one competitor's ads: their creative, offers and landing pages. Pass `pageId` (exact) or `companyName` (we use the top match). Stopped ads are included unless you pass `status=active`.\n\nGet `pageId` from search companies (facebook_search_companies), or from the `view_all_page_id` in an Ad Library URL. With `companyName`, the response's `page_id` and `page_name` say which page we matched, and no match returns 404 `not_found`. The ads are under `results` (keyword search uses `searchResults`).\n\n**Pagination.** The first page has up to 30 ads and `searchResultsCount`, the estimated total. For more, pass `cursor` back with the same filters. Later pages have up to 10 ads (Facebook's own page size), and `searchResultsCount` is null there. `cursor` is null on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/company-ads"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "pageId",
            "in": "query",
            "required": false,
            "description": "The advertiser's Facebook page id, e.g. `15087023444` (Nike). Required unless you pass `companyName`.",
            "schema": {
              "description": "The advertiser's Facebook page id, e.g. `15087023444` (Nike). Required unless you pass `companyName`.",
              "type": "string",
              "pattern": "^\\d+$"
            },
            "example": "15087023444"
          },
          {
            "name": "companyName",
            "in": "query",
            "required": false,
            "description": "Advertiser name, e.g. `Nike`. We use the top match from search companies. Ignored when `pageId` is set.",
            "schema": {
              "description": "Advertiser name, e.g. `Nike`. We use the top match from search companies. Ignored when `pageId` is set.",
              "type": "string",
              "minLength": 1
            }
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "The country the ad ran in, as a 2-letter code (US, GB, DE…), or ALL for every country. One country per request.",
            "schema": {
              "description": "The country the ad ran in, as a 2-letter code (US, GB, DE…), or ALL for every country. One country per request.",
              "default": "ALL",
              "type": "string",
              "pattern": "^(ALL|[A-Z]{2})$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only ads that are running now (active), only stopped ads (inactive), or both (all).",
            "schema": {
              "description": "Only ads that are running now (active), only stopped ads (inactive), or both (all).",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "active",
                "inactive"
              ]
            },
            "example": "active"
          },
          {
            "name": "media_type",
            "in": "query",
            "required": false,
            "description": "Ad format. `meme` is Facebook's name for an image with text. `none` means text-only ads.",
            "schema": {
              "description": "Ad format. `meme` is Facebook's name for an image with text. `none` means text-only ads.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "image",
                "video",
                "meme",
                "image_and_meme",
                "none"
              ]
            }
          },
          {
            "name": "ad_type",
            "in": "query",
            "required": false,
            "description": "Ad category. Political and issue ads also show spend and impression ranges.",
            "schema": {
              "description": "Ad category. Political and issue ads also show spend and impression ranges.",
              "default": "ALL",
              "type": "string",
              "enum": [
                "ALL",
                "POLITICAL_AND_ISSUE_ADS",
                "EMPLOYMENT_ADS",
                "HOUSING_ADS",
                "CREDIT_ADS"
              ]
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Language of the ad text as an ISO 639-1 code, e.g. `en` or `es`.",
            "schema": {
              "description": "Language of the ad text as an ISO 639-1 code, e.g. `en` or `es`.",
              "type": "string",
              "pattern": "^([a-z]{2}|cmn|yue)$"
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "description": "`total_impressions` puts the most-seen ads first. `relevancy_monthly_grouped` puts the newest first.",
            "schema": {
              "description": "`total_impressions` puts the most-seen ads first. `relevancy_monthly_grouped` puts the newest first.",
              "default": "total_impressions",
              "type": "string",
              "enum": [
                "total_impressions",
                "relevancy_monthly_grouped"
              ]
            }
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "description": "Only ads shown on or after this date (YYYY-MM-DD). The ad itself may have launched earlier.",
            "schema": {
              "description": "Only ads shown on or after this date (YYYY-MM-DD). The ad itself may have launched earlier.",
              "type": "string"
            }
          },
          {
            "name": "end_date",
            "in": "query",
            "required": false,
            "description": "Only ads shown on or before this date (YYYY-MM-DD).",
            "schema": {
              "description": "Only ads shown on or before this date (YYYY-MM-DD).",
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page. Keep every other param the same.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page. Keep every other param the same.",
              "type": "string"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "`true` leaves out image and video URLs, including those in `snapshot.cards`, for a much smaller response. All text stays.",
            "schema": {
              "description": "`true` leaves out image and video URLs, including those in `snapshot.cards`, for a much smaller response. All text stays.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Every ad one advertiser is running (or ran) on Facebook and Instagram, from Meta's Ad Library.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "page_id": {
                      "type": "string",
                      "description": "The page these ads are from: `pageId` as given, or the page we matched for `companyName`."
                    },
                    "page_name": {
                      "description": "That page's name (the matched page for `companyName`, else from the ads); null when there are no ads.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "ad_archive_id": {
                            "description": "The Ad Library id. Pass it as `id` to the ad details endpoint.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "ad_id": {
                            "description": "Meta's internal ad id. null in every response we've seen; use the Ad Library id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "page_id": {
                            "description": "The advertiser's Facebook page id. Pass it as `pageId` to the company ads endpoint.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "page_name": {
                            "description": "The advertiser's page name.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "is_active": {
                            "type": "boolean",
                            "description": "Whether the ad is running now."
                          },
                          "start_date": {
                            "description": "The day the ad started running, as Unix seconds at midnight Pacific time.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "end_date": {
                            "description": "The day the ad stopped, or its latest delivery day if still running, as Unix seconds at midnight Pacific time.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "start_date_string": {
                            "description": "The same date as ISO 8601 text when Facebook includes it; null in every response we've seen, so use the Unix seconds field.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "end_date_string": {
                            "description": "The same date as ISO 8601 text when Facebook includes it; null in every response we've seen, so use the Unix seconds field.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "total_active_time": {
                            "description": "Seconds the ad has run, when Facebook reports it; usually null.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "publisher_platform": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Where it ran, uppercase: FACEBOOK, INSTAGRAM, AUDIENCE_NETWORK, MESSENGER, THREADS."
                          },
                          "collation_count": {
                            "description": "How many near-identical versions are grouped under this ad. A high count means the advertiser is scaling it; null for a single version.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "collation_id": {
                            "description": "Id shared by the grouped versions of this ad; null for a single version.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "snapshot": {
                            "type": "object",
                            "properties": {
                              "page_id": {
                                "description": "The advertiser's page id (same as the ad's).",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_name": {
                                "description": "The advertiser's page name as shown on the ad.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_profile_uri": {
                                "description": "The advertiser's Facebook page URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_profile_picture_url": {
                                "description": "The advertiser's profile picture, 60×60 px.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "page_like_count": {
                                "description": "Followers of the advertiser's page.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "page_categories": {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                },
                                "description": "Page categories, e.g. [\"Outdoor & Sporting Goods Company\"]."
                              },
                              "page_is_deleted": {
                                "type": "boolean",
                                "description": "Whether the advertiser's page has been deleted."
                              },
                              "title": {
                                "description": "Headline under the creative; null when there is none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "caption": {
                                "description": "Display link under the creative, usually the domain (e.g. HOKA.com).",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "link_url": {
                                "description": "Landing page the ad sends people to, UTM tags included.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "link_description": {
                                "description": "Text under the headline; null when there is none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cta_text": {
                                "description": "Button label, e.g. \"Shop now\".",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cta_type": {
                                "description": "Button type, e.g. SHOP_NOW, LEARN_MORE, NO_BUTTON.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "display_format": {
                                "description": "Creative format, e.g. IMAGE, VIDEO, DCO (dynamic creative), DPA (dynamic product ad) or MULTI_IMAGES. For DCO and DPA ads the creative is in `cards`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "images": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "original_image_url": {
                                      "description": "Full-size image URL. Facebook's links expire after a few days, so download what you need.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "resized_image_url": {
                                      "description": "600 px image URL, good for thumbnails.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_resized_image_url": {
                                      "type": "string",
                                      "description": "Watermarked copy; empty or null in every response we've seen."
                                    },
                                    "image_crops": {
                                      "type": "array",
                                      "items": {},
                                      "description": "Facebook internal field; an empty array in every response we've seen. Crop hints for the image."
                                    }
                                  },
                                  "required": [
                                    "original_image_url",
                                    "resized_image_url",
                                    "watermarked_resized_image_url",
                                    "image_crops"
                                  ],
                                  "additionalProperties": false
                                },
                                "description": "Image creatives. Empty for video and card-based ads, and with trim=true."
                              },
                              "videos": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "video_hd_url": {
                                      "description": "HD video file URL; null if Facebook has no HD version.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_sd_url": {
                                      "description": "SD video file URL.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_preview_image_url": {
                                      "description": "Poster frame (still image) URL.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_hd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_sd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "video_hd_url",
                                    "video_sd_url",
                                    "video_preview_image_url",
                                    "watermarked_video_hd_url",
                                    "watermarked_video_sd_url"
                                  ],
                                  "additionalProperties": false
                                },
                                "description": "Video creatives. Empty for image and card-based ads, and with trim=true."
                              },
                              "cards": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "title": {
                                      "description": "This version's headline.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "body": {
                                      "description": "This version's primary text.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "caption": {
                                      "description": "This version's display link, usually the domain.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "cta_text": {
                                      "description": "Button label, e.g. \"Shop now\".",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "cta_type": {
                                      "description": "Button type, e.g. SHOP_NOW, LEARN_MORE.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "link_url": {
                                      "description": "This version's landing page URL.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "link_description": {
                                      "description": "Text under the headline; null when there is none.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "original_image_url": {
                                      "description": "Full-size image URL; null for video versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "resized_image_url": {
                                      "description": "600 px image URL; null for video versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_resized_image_url": {
                                      "type": "string",
                                      "description": "Watermarked copy; empty or null in every response we've seen."
                                    },
                                    "image_crops": {
                                      "type": "array",
                                      "items": {},
                                      "description": "Facebook internal field; an empty array in every response we've seen. Crop hints for the image."
                                    },
                                    "video_hd_url": {
                                      "description": "HD video file URL; null for image versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_sd_url": {
                                      "description": "SD video file URL; null for image versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "video_preview_image_url": {
                                      "description": "Poster frame URL; null for image versions.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_hd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "watermarked_video_sd_url": {
                                      "description": "Watermarked copy; empty or null in every response we've seen.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "title",
                                    "body",
                                    "caption",
                                    "cta_text",
                                    "cta_type",
                                    "link_url",
                                    "link_description",
                                    "original_image_url",
                                    "resized_image_url",
                                    "watermarked_resized_image_url",
                                    "image_crops",
                                    "video_hd_url",
                                    "video_sd_url",
                                    "video_preview_image_url",
                                    "watermarked_video_hd_url",
                                    "watermarked_video_sd_url"
                                  ],
                                  "additionalProperties": false
                                },
                                "description": "Carousel, dynamic-creative and product versions, each with its own copy and media. With trim=true the text stays and media URLs are null."
                              },
                              "byline": {
                                "description": "Who paid for the ad (the \"Paid for by\" name) on political and issue ads; null on most others.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "disclaimer_label": {
                                "description": "The disclaimer kind on political and issue ads, e.g. PAID_FOR_BY (the name is in `byline`); null otherwise.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "country_iso_code": {
                                "description": "Facebook internal field; null in every response we've seen. A country code on some ads.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "is_reshared": {
                                "type": "boolean",
                                "description": "Whether the ad reshares an existing post (see `root_reshared_post`)."
                              },
                              "root_reshared_post": {
                                "description": "The original post when `is_reshared` is true; null otherwise."
                              },
                              "branded_content": {
                                "description": "Paid partnership details when the ad is branded content; null otherwise."
                              },
                              "additional_info": {
                                "description": "Facebook internal field; null in every response we've seen."
                              },
                              "brazil_tax_id": {
                                "description": "Advertiser tax id shown on ads under Brazil's rules; null otherwise."
                              },
                              "ec_certificates": {
                                "type": "array",
                                "items": {},
                                "description": "Facebook internal field; an empty array in every response we've seen."
                              },
                              "event": {
                                "description": "Event details on event ads; null otherwise."
                              },
                              "extra_images": {
                                "type": "array",
                                "items": {},
                                "description": "More images from dynamic creative; usually empty."
                              },
                              "extra_links": {
                                "type": "array",
                                "items": {},
                                "description": "More landing page URLs from dynamic creative; usually empty."
                              },
                              "extra_texts": {
                                "type": "array",
                                "items": {},
                                "description": "More text variations from dynamic creative; usually empty."
                              },
                              "extra_videos": {
                                "type": "array",
                                "items": {},
                                "description": "More videos from dynamic creative; usually empty."
                              },
                              "body": {
                                "anyOf": [
                                  {
                                    "type": "object",
                                    "properties": {
                                      "text": {
                                        "description": "The ad's primary text.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "text"
                                    ],
                                    "additionalProperties": false
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "Primary text as `{ text }`; null when the copy is only in `cards`."
                              }
                            },
                            "required": [
                              "page_id",
                              "page_name",
                              "page_profile_uri",
                              "page_profile_picture_url",
                              "page_like_count",
                              "page_categories",
                              "page_is_deleted",
                              "title",
                              "caption",
                              "link_url",
                              "link_description",
                              "cta_text",
                              "cta_type",
                              "display_format",
                              "images",
                              "videos",
                              "cards",
                              "byline",
                              "disclaimer_label",
                              "country_iso_code",
                              "is_reshared",
                              "root_reshared_post",
                              "branded_content",
                              "additional_info",
                              "brazil_tax_id",
                              "ec_certificates",
                              "event",
                              "extra_images",
                              "extra_links",
                              "extra_texts",
                              "extra_videos",
                              "body"
                            ],
                            "additionalProperties": false,
                            "description": "The creative: copy, media, landing page and advertiser details."
                          },
                          "categories": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Special ad categories Facebook assigned. [\"UNKNOWN\"] for ordinary ads."
                          },
                          "targeted_or_reached_countries": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Countries the ad targeted or reached, when Facebook discloses them; empty in most results."
                          },
                          "currency": {
                            "type": "string",
                            "description": "Currency code of `spend` (e.g. USD) when spend is reported; an empty string otherwise."
                          },
                          "spend": {
                            "description": "Spend range as Facebook shows it, e.g. \"$600K - $700K\" or \">$1M\" (see `currency`). Political and issue ads only; null otherwise."
                          },
                          "impressions_with_index": {
                            "type": "object",
                            "properties": {
                              "impressions_text": {
                                "description": "The range as Facebook shows it; null when not reported.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "impressions_index": {
                                "type": "number",
                                "description": "Facebook's bucket number for the range; -1 when not reported. Ad details usually omit it."
                              }
                            },
                            "required": [
                              "impressions_text",
                              "impressions_index"
                            ],
                            "additionalProperties": false,
                            "description": "Impressions range, reported for political and issue ads only."
                          },
                          "reach_estimate": {
                            "description": "Estimated reach as Facebook shows it, e.g. \">1M\", on political and issue ads and some EU-delivered ads; null otherwise."
                          },
                          "url": {
                            "description": "Ad Library link for this ad. null in every response we've seen; build it as https://www.facebook.com/ads/library/?id=<Ad Library id>.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "contains_digital_created_media": {
                            "type": "boolean",
                            "description": "Whether Facebook labels the creative as AI-generated or digitally altered."
                          },
                          "contains_sensitive_content": {
                            "type": "boolean",
                            "description": "Facebook internal field; false in every response we've seen. Facebook's sensitive-content flag."
                          },
                          "gated_type": {
                            "type": "string",
                            "description": "Facebook internal field; ELIGIBLE (lowercase in ad details) in every response we've seen."
                          },
                          "has_user_reported": {
                            "type": "boolean",
                            "description": "Whether the viewer reported the ad. Always false, since we read the Ad Library logged out."
                          },
                          "hide_data_status": {
                            "type": "string",
                            "description": "Facebook internal field; NONE in every response we've seen."
                          },
                          "is_aaa_eligible": {
                            "type": "boolean",
                            "description": "Facebook flag, true on a few ads; meaning undocumented. Ad details' `aaa_info` holds the related data when present."
                          },
                          "menu_items": {
                            "type": "array",
                            "items": {},
                            "description": "Facebook internal field; an empty array in every response we've seen."
                          },
                          "page_is_deleted": {
                            "type": "boolean",
                            "description": "Whether the advertiser's page has been deleted."
                          },
                          "regional_regulation_data": {
                            "type": "object",
                            "properties": {
                              "finserv": {
                                "type": "object",
                                "properties": {
                                  "is_deemed_finserv": {
                                    "type": "boolean",
                                    "description": "Facebook treats the ad as a financial-services ad."
                                  },
                                  "is_limited_delivery": {
                                    "type": "boolean",
                                    "description": "Delivery is limited under financial-services rules."
                                  }
                                },
                                "required": [
                                  "is_deemed_finserv",
                                  "is_limited_delivery"
                                ],
                                "additionalProperties": false,
                                "description": "Financial-services ad rules."
                              },
                              "tw_anti_scam": {
                                "type": "object",
                                "properties": {
                                  "is_limited_delivery": {
                                    "type": "boolean",
                                    "description": "Delivery is limited under Taiwan's anti-scam rules."
                                  }
                                },
                                "required": [
                                  "is_limited_delivery"
                                ],
                                "additionalProperties": false,
                                "description": "Taiwan's anti-scam ad rules."
                              }
                            },
                            "required": [
                              "finserv",
                              "tw_anti_scam"
                            ],
                            "additionalProperties": false,
                            "description": "Delivery limits under regional ad rules."
                          },
                          "report_count": {
                            "description": "Times the ad was reported, when disclosed; null in every response we've seen.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "fev_info": {
                            "description": "Facebook internal field; null in every response we've seen."
                          },
                          "state_media_run_label": {
                            "description": "Label for ads run by state-controlled media; null otherwise."
                          }
                        },
                        "required": [
                          "ad_archive_id",
                          "ad_id",
                          "page_id",
                          "page_name",
                          "is_active",
                          "start_date",
                          "end_date",
                          "start_date_string",
                          "end_date_string",
                          "total_active_time",
                          "publisher_platform",
                          "collation_count",
                          "collation_id",
                          "snapshot",
                          "categories",
                          "targeted_or_reached_countries",
                          "currency",
                          "spend",
                          "impressions_with_index",
                          "reach_estimate",
                          "url",
                          "contains_digital_created_media",
                          "contains_sensitive_content",
                          "gated_type",
                          "has_user_reported",
                          "hide_data_status",
                          "is_aaa_eligible",
                          "menu_items",
                          "page_is_deleted",
                          "regional_regulation_data",
                          "report_count",
                          "fev_info",
                          "state_media_run_label"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The advertiser's ads."
                    },
                    "searchResultsCount": {
                      "description": "Total matching ads, as Facebook estimates it. Only on the first page; null on cursor pages.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "page_id",
                    "page_name",
                    "results",
                    "searchResultsCount",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/adLibrary/ad": {
      "get": {
        "operationId": "facebook_ad",
        "tags": [
          "Facebook"
        ],
        "summary": "Ad Library ad details",
        "description": "Full detail for one ad from Meta's Ad Library, by its id or URL.\n\nUse it to get one ad in full after a search: its copy, every image and video, landing page, platforms and run dates. Pass its `ad_archive_id` as `id`, or an Ad Library link as `url`. Top-level keys here are camelCase (`adArchiveID`, `isActive`).\n\nTwo more differences from the list endpoints: `publisherPlatform` values are lowercase, and `snapshot.body` is a plain string. Ads with several versions keep their creative in `snapshot.cards`.\n\nReturns 404 `not_found` if the ad doesn't exist.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/ad"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "The ad's Ad Library id (`ad_archive_id`), e.g. `2763572613808775`. Required unless you pass `url`.",
            "schema": {
              "description": "The ad's Ad Library id (`ad_archive_id`), e.g. `2763572613808775`. Required unless you pass `url`.",
              "type": "string",
              "pattern": "^\\d+$"
            },
            "example": "2763572613808775"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "An Ad Library link containing `?id=…`, e.g. `https://www.facebook.com/ads/library/?id=2763572613808775`.",
            "schema": {
              "description": "An Ad Library link containing `?id=…`, e.g. `https://www.facebook.com/ads/library/?id=2763572613808775`.",
              "type": "string"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "`true` drops image and video URLs (inside `snapshot.cards` too). All text is kept.",
            "schema": {
              "description": "`true` drops image and video URLs (inside `snapshot.cards` too). All text is kept.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Full detail for one ad from Meta's Ad Library, by its id or URL.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "adArchiveID": {
                      "description": "The Ad Library id. Pass it as `id` to the ad details endpoint.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "adid": {
                      "description": "Meta's internal ad id. null in every response we've seen; use the Ad Library id.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "pageID": {
                      "description": "The advertiser's Facebook page id. Pass it as `pageId` to the company ads endpoint.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "pageName": {
                      "description": "The advertiser's page name.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "isActive": {
                      "type": "boolean",
                      "description": "Whether the ad is running now."
                    },
                    "startDate": {
                      "description": "The day the ad started running, as Unix seconds at midnight Pacific time.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "endDate": {
                      "description": "The day the ad stopped, or its latest delivery day if still running, as Unix seconds at midnight Pacific time.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "startDateString": {
                      "description": "The same date as ISO 8601 text when Facebook includes it; null in every response we've seen, so use the Unix seconds field.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "endDateString": {
                      "description": "The same date as ISO 8601 text when Facebook includes it; null in every response we've seen, so use the Unix seconds field.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "totalActiveTime": {
                      "description": "Seconds the ad has run, when Facebook reports it; usually null.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "publisherPlatform": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Where it ran, lowercase: facebook, instagram, audience_network, messenger, threads."
                    },
                    "collationCount": {
                      "description": "How many near-identical versions are grouped under this ad. A high count means the advertiser is scaling it; null for a single version.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "collationID": {
                      "description": "Id shared by the grouped versions of this ad; null for a single version.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "snapshot": {
                      "type": "object",
                      "properties": {
                        "page_id": {
                          "description": "The advertiser's page id (same as the ad's).",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "page_name": {
                          "description": "The advertiser's page name as shown on the ad.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "page_profile_uri": {
                          "description": "The advertiser's Facebook page URL.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "page_profile_picture_url": {
                          "description": "The advertiser's profile picture, 60×60 px.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "page_like_count": {
                          "description": "Followers of the advertiser's page.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "page_categories": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Page categories, e.g. [\"Outdoor & Sporting Goods Company\"]."
                        },
                        "page_is_deleted": {
                          "type": "boolean",
                          "description": "Whether the advertiser's page has been deleted."
                        },
                        "title": {
                          "description": "Headline under the creative; null when there is none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "caption": {
                          "description": "Display link under the creative, usually the domain (e.g. HOKA.com).",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "link_url": {
                          "description": "Landing page the ad sends people to, UTM tags included.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "link_description": {
                          "description": "Text under the headline; null when there is none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "cta_text": {
                          "description": "Button label, e.g. \"Shop now\".",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "cta_type": {
                          "description": "Button type, e.g. SHOP_NOW, LEARN_MORE, NO_BUTTON.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "display_format": {
                          "description": "Creative format, e.g. IMAGE, VIDEO, DCO (dynamic creative), DPA (dynamic product ad) or MULTI_IMAGES. For DCO and DPA ads the creative is in `cards`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "images": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "original_image_url": {
                                "description": "Full-size image URL. Facebook's links expire after a few days, so download what you need.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "resized_image_url": {
                                "description": "600 px image URL, good for thumbnails.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "watermarked_resized_image_url": {
                                "type": "string",
                                "description": "Watermarked copy; empty or null in every response we've seen."
                              },
                              "image_crops": {
                                "type": "array",
                                "items": {},
                                "description": "Facebook internal field; an empty array in every response we've seen. Crop hints for the image."
                              }
                            },
                            "required": [
                              "original_image_url",
                              "resized_image_url",
                              "watermarked_resized_image_url",
                              "image_crops"
                            ],
                            "additionalProperties": false
                          },
                          "description": "Image creatives. Empty for video and card-based ads, and with trim=true."
                        },
                        "videos": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "video_hd_url": {
                                "description": "HD video file URL; null if Facebook has no HD version.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "video_sd_url": {
                                "description": "SD video file URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "video_preview_image_url": {
                                "description": "Poster frame (still image) URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "watermarked_video_hd_url": {
                                "description": "Watermarked copy; empty or null in every response we've seen.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "watermarked_video_sd_url": {
                                "description": "Watermarked copy; empty or null in every response we've seen.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "video_hd_url",
                              "video_sd_url",
                              "video_preview_image_url",
                              "watermarked_video_hd_url",
                              "watermarked_video_sd_url"
                            ],
                            "additionalProperties": false
                          },
                          "description": "Video creatives. Empty for image and card-based ads, and with trim=true."
                        },
                        "cards": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "description": "This version's headline.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "body": {
                                "description": "This version's primary text.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "caption": {
                                "description": "This version's display link, usually the domain.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cta_text": {
                                "description": "Button label, e.g. \"Shop now\".",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cta_type": {
                                "description": "Button type, e.g. SHOP_NOW, LEARN_MORE.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "link_url": {
                                "description": "This version's landing page URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "link_description": {
                                "description": "Text under the headline; null when there is none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "original_image_url": {
                                "description": "Full-size image URL; null for video versions.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "resized_image_url": {
                                "description": "600 px image URL; null for video versions.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "watermarked_resized_image_url": {
                                "type": "string",
                                "description": "Watermarked copy; empty or null in every response we've seen."
                              },
                              "image_crops": {
                                "type": "array",
                                "items": {},
                                "description": "Facebook internal field; an empty array in every response we've seen. Crop hints for the image."
                              },
                              "video_hd_url": {
                                "description": "HD video file URL; null for image versions.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "video_sd_url": {
                                "description": "SD video file URL; null for image versions.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "video_preview_image_url": {
                                "description": "Poster frame URL; null for image versions.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "watermarked_video_hd_url": {
                                "description": "Watermarked copy; empty or null in every response we've seen.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "watermarked_video_sd_url": {
                                "description": "Watermarked copy; empty or null in every response we've seen.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "title",
                              "body",
                              "caption",
                              "cta_text",
                              "cta_type",
                              "link_url",
                              "link_description",
                              "original_image_url",
                              "resized_image_url",
                              "watermarked_resized_image_url",
                              "image_crops",
                              "video_hd_url",
                              "video_sd_url",
                              "video_preview_image_url",
                              "watermarked_video_hd_url",
                              "watermarked_video_sd_url"
                            ],
                            "additionalProperties": false
                          },
                          "description": "Carousel, dynamic-creative and product versions, each with its own copy and media. With trim=true the text stays and media URLs are null."
                        },
                        "byline": {
                          "description": "Who paid for the ad (the \"Paid for by\" name) on political and issue ads; null on most others.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "disclaimer_label": {
                          "description": "The disclaimer kind on political and issue ads, e.g. PAID_FOR_BY (the name is in `byline`); null otherwise.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "country_iso_code": {
                          "description": "Facebook internal field; null in every response we've seen. A country code on some ads.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "is_reshared": {
                          "type": "boolean",
                          "description": "Whether the ad reshares an existing post (see `root_reshared_post`)."
                        },
                        "root_reshared_post": {
                          "description": "The original post when `is_reshared` is true; null otherwise."
                        },
                        "branded_content": {
                          "description": "Paid partnership details when the ad is branded content; null otherwise."
                        },
                        "additional_info": {
                          "description": "Facebook internal field; null in every response we've seen."
                        },
                        "brazil_tax_id": {
                          "description": "Advertiser tax id shown on ads under Brazil's rules; null otherwise."
                        },
                        "ec_certificates": {
                          "type": "array",
                          "items": {},
                          "description": "Facebook internal field; an empty array in every response we've seen."
                        },
                        "event": {
                          "description": "Event details on event ads; null otherwise."
                        },
                        "extra_images": {
                          "type": "array",
                          "items": {},
                          "description": "More images from dynamic creative; usually empty."
                        },
                        "extra_links": {
                          "type": "array",
                          "items": {},
                          "description": "More landing page URLs from dynamic creative; usually empty."
                        },
                        "extra_texts": {
                          "type": "array",
                          "items": {},
                          "description": "More text variations from dynamic creative; usually empty."
                        },
                        "extra_videos": {
                          "type": "array",
                          "items": {},
                          "description": "More videos from dynamic creative; usually empty."
                        },
                        "body": {
                          "description": "The ad's primary text as a plain string; null when the copy is only in `cards`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "final_url": {
                          "description": "Final landing URL after redirects, when Facebook reports it; usually null.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "page_id",
                        "page_name",
                        "page_profile_uri",
                        "page_profile_picture_url",
                        "page_like_count",
                        "page_categories",
                        "page_is_deleted",
                        "title",
                        "caption",
                        "link_url",
                        "link_description",
                        "cta_text",
                        "cta_type",
                        "display_format",
                        "images",
                        "videos",
                        "cards",
                        "byline",
                        "disclaimer_label",
                        "country_iso_code",
                        "is_reshared",
                        "root_reshared_post",
                        "branded_content",
                        "additional_info",
                        "brazil_tax_id",
                        "ec_certificates",
                        "event",
                        "extra_images",
                        "extra_links",
                        "extra_texts",
                        "extra_videos",
                        "body",
                        "final_url"
                      ],
                      "additionalProperties": false,
                      "description": "The creative: copy, media, landing page and advertiser details (snake_case inside)."
                    },
                    "categories": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Special ad categories Facebook assigned. [\"UNKNOWN\"] for ordinary ads."
                    },
                    "currency": {
                      "type": "string",
                      "description": "Currency code of `spend` (e.g. USD) when spend is reported; an empty string otherwise."
                    },
                    "spend": {
                      "description": "Spend range as Facebook shows it, e.g. \"$600K - $700K\" or \">$1M\" (see `currency`). Political and issue ads only; null otherwise."
                    },
                    "impressionsWithIndex": {
                      "type": "object",
                      "properties": {
                        "impressionsText": {
                          "description": "The range as Facebook shows it; null when not reported.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "impressionsIndex": {
                          "type": "number",
                          "description": "Facebook's bucket number for the range; -1 when not reported. Ad details usually omit it."
                        }
                      },
                      "required": [
                        "impressionsText",
                        "impressionsIndex"
                      ],
                      "additionalProperties": false,
                      "description": "Impressions range, reported for political and issue ads only."
                    },
                    "reachEstimate": {
                      "description": "Estimated reach as Facebook shows it, e.g. \">1M\", on political and issue ads and some EU-delivered ads; null otherwise."
                    },
                    "url": {
                      "description": "Ad Library link for this ad. null in every response we've seen; build it as https://www.facebook.com/ads/library/?id=<Ad Library id>.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "containsDigitallyCreatedMedia": {
                      "type": "boolean",
                      "description": "Whether Facebook labels the creative as AI-generated or digitally altered."
                    },
                    "containsSensitiveContent": {
                      "type": "boolean",
                      "description": "Facebook internal field; false in every response we've seen. Facebook's sensitive-content flag."
                    },
                    "gatedType": {
                      "type": "string",
                      "description": "Facebook internal field; ELIGIBLE (lowercase in ad details) in every response we've seen."
                    },
                    "hasUserReported": {
                      "type": "boolean",
                      "description": "Whether the viewer reported the ad. Always false, since we read the Ad Library logged out."
                    },
                    "hideDataStatus": {
                      "type": "string",
                      "description": "Facebook internal field; NONE in every response we've seen."
                    },
                    "isAAAEligible": {
                      "type": "boolean",
                      "description": "Facebook flag, true on a few ads; meaning undocumented. Ad details' `aaa_info` holds the related data when present."
                    },
                    "menuItems": {
                      "type": "array",
                      "items": {},
                      "description": "Facebook internal field; an empty array in every response we've seen."
                    },
                    "pageIsDeleted": {
                      "type": "boolean",
                      "description": "Whether the advertiser's page has been deleted."
                    },
                    "regionalRegulationData": {
                      "type": "object",
                      "properties": {
                        "finserv": {
                          "type": "object",
                          "properties": {
                            "is_deemed_finserv": {
                              "type": "boolean",
                              "description": "Facebook treats the ad as a financial-services ad."
                            },
                            "is_limited_delivery": {
                              "type": "boolean",
                              "description": "Delivery is limited under financial-services rules."
                            }
                          },
                          "required": [
                            "is_deemed_finserv",
                            "is_limited_delivery"
                          ],
                          "additionalProperties": false,
                          "description": "Financial-services ad rules."
                        },
                        "tw_anti_scam": {
                          "type": "object",
                          "properties": {
                            "is_limited_delivery": {
                              "type": "boolean",
                              "description": "Delivery is limited under Taiwan's anti-scam rules."
                            }
                          },
                          "required": [
                            "is_limited_delivery"
                          ],
                          "additionalProperties": false,
                          "description": "Taiwan's anti-scam ad rules."
                        }
                      },
                      "required": [
                        "finserv",
                        "tw_anti_scam"
                      ],
                      "additionalProperties": false,
                      "description": "Delivery limits under regional ad rules."
                    },
                    "reportCount": {
                      "description": "Times the ad was reported, when disclosed; null in every response we've seen.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "fevInfo": {
                      "description": "Facebook internal field; null in every response we've seen."
                    },
                    "stateMediaRunLabel": {
                      "description": "Label for ads run by state-controlled media; null otherwise."
                    },
                    "aaa_info": {
                      "description": "Extra transparency data on some ads (see `isAAAEligible`); null in every response we've seen."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "adArchiveID",
                    "adid",
                    "pageID",
                    "pageName",
                    "isActive",
                    "startDate",
                    "endDate",
                    "startDateString",
                    "endDateString",
                    "totalActiveTime",
                    "publisherPlatform",
                    "collationCount",
                    "collationID",
                    "snapshot",
                    "categories",
                    "currency",
                    "spend",
                    "impressionsWithIndex",
                    "reachEstimate",
                    "url",
                    "containsDigitallyCreatedMedia",
                    "containsSensitiveContent",
                    "gatedType",
                    "hasUserReported",
                    "hideDataStatus",
                    "isAAAEligible",
                    "menuItems",
                    "pageIsDeleted",
                    "regionalRegulationData",
                    "reportCount",
                    "fevInfo",
                    "stateMediaRunLabel",
                    "aaa_info"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/adLibrary/search/companies": {
      "get": {
        "operationId": "facebook_search_companies",
        "tags": [
          "Facebook"
        ],
        "summary": "Search Ad Library companies",
        "description": "Find an advertiser's Facebook page id by name in Meta's Ad Library, with followers and linked Instagram.\n\nUse it to turn a brand name into the `page_id` that company ads (facebook_company_ads) needs. Big brands often have several pages, for regions or product lines. Pick one by `name`, `likes` and `verification`.\n\nYou get the advertisers the search box at facebook.com/ads/library suggests as you type: up to about 15, in one call, with no further pages.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/search-companies"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Brand or page name, e.g. `nike`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "description": "Brand or page name, e.g. `nike`."
            },
            "example": "nike"
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "A 2-letter country code (US, GB…) whose pages rank first, or ALL.",
            "schema": {
              "description": "A 2-letter country code (US, GB…) whose pages rank first, or ALL.",
              "default": "US",
              "type": "string",
              "pattern": "^(ALL|[A-Z]{2})$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Find an advertiser's Facebook page id by name in Meta's Ad Library, with followers and linked Instagram.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "searchResults": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "page_id": {
                            "description": "The page id. Pass it as `pageId` to the company ads endpoint.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "name": {
                            "description": "The page's name.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "page_alias": {
                            "description": "Vanity name: facebook.com/<page_alias>.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "category": {
                            "description": "Page category, e.g. \"Sportswear Store\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "likes": {
                            "description": "Page followers.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "verification": {
                            "description": "BLUE_VERIFIED or NOT_VERIFIED.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "image_uri": {
                            "description": "Profile picture URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "ig_username": {
                            "description": "Linked Instagram username, without @; null when none is linked.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "ig_followers": {
                            "description": "Followers of the linked Instagram account; null when none is linked.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "ig_verification": {
                            "type": "boolean",
                            "description": "Whether the linked Instagram account is verified; false when none is linked."
                          },
                          "country": {
                            "description": "The page's country; null in every response we've seen.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "entity_type": {
                            "description": "Facebook's page type; PERSON_PROFILE for most pages, brands included.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "page_is_deleted": {
                            "type": "boolean",
                            "description": "Whether the page has been deleted."
                          }
                        },
                        "required": [
                          "page_id",
                          "name",
                          "page_alias",
                          "category",
                          "likes",
                          "verification",
                          "image_uri",
                          "ig_username",
                          "ig_followers",
                          "ig_verification",
                          "country",
                          "entity_type",
                          "page_is_deleted"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching advertiser pages, best match first."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "searchResults"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/profile": {
      "get": {
        "operationId": "facebook_profile",
        "tags": [
          "Facebook"
        ],
        "summary": "Public profile",
        "description": "A Facebook Page's or public person's name, pictures, follower counts and contact details.\n\nUse it to look up a Page or a person: name, pictures and follower counts. Pages also return the contact details on their Intro card when they show them: category, email, phone, address, websites, rating and price range. For posts, use profile posts (facebook_profile_posts).\n\nPass any profile URL: a username, a profile.php?id= link or a /people/ link. `type` says whether it's a Page or a personal profile. You get what a logged-out visitor sees, and fields that don't apply stay null.\n\nA private personal profile returns 403 `not_public`, and an unknown username 404 `not_found`. Both are charged. Facebook shows the same page for a private profile as for a deleted or unused profile.php id, so those return `not_public` too.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A Facebook Page or personal profile URL, e.g. https://www.facebook.com/NASA. Also accepts profile.php?id=…, /people/<name>/<id> and /pages/<name>/<id> links. Group and share links don't work.",
            "schema": {
              "description": "A Facebook Page or personal profile URL, e.g. https://www.facebook.com/NASA. Also accepts profile.php?id=…, /people/<name>/<id> and /pages/<name>/<id> links. Group and share links don't work.",
              "type": "string"
            },
            "example": "https://www.facebook.com/NASA"
          }
        ],
        "responses": {
          "200": {
            "description": "A Facebook Page's or public person's name, pictures, follower counts and contact details.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Facebook's profile id. New-style Pages and professional-mode personal profiles also have a separate page_id."
                    },
                    "type": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "page",
                            "personal"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "`page` for a business Page, `personal` for a person's profile (including professional mode); null if Facebook doesn't say."
                    },
                    "page_id": {
                      "description": "The Page id to pass as `pageId` to Ad Library company ads (facebook_company_ads). Every Page has one. Personal profiles have one only in professional mode; otherwise null.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "description": "The canonical public Facebook profile URL."
                    },
                    "name": {
                      "type": "string",
                      "description": "The Page or person's display name."
                    },
                    "description": {
                      "description": "The profile's public description, word for word. It can include the name, follower counts and bio.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "is_verified": {
                      "description": "Whether the public header shows Facebook's verification badge; null if omitted.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "followers_count": {
                      "description": "Exact follower count. Rounded counts like 28M are never turned into numbers (see `followers_text`); null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "followers_text": {
                      "description": "The follower count label shown in the header, which is often rounded (for example 28M followers).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "following_count": {
                      "description": "Exact following count, when the public header shows an unrounded number; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "talking_about_count": {
                      "description": "How many people are talking about the profile, as Facebook reports it. Pages and professional-mode profiles only; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "profile_picture_url": {
                      "description": "Profile picture URL. The link expires.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "cover_photo_url": {
                      "description": "Cover photo URL; null when there is none. The link expires.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "category": {
                      "description": "The Page's category from its Intro card, e.g. Restaurant or Government organization; null when none is shown",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "email": {
                      "description": "The contact email the Intro card shows; null when none is public",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "phone": {
                      "description": "The contact phone number as the Intro card shows it, e.g. (916) 999-1749; null when none is public",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "address": {
                      "description": "The street address the Intro card shows; null when none is public",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "websites": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "A website URL."
                      },
                      "description": "Websites the Intro card links, in its order; empty when none."
                    },
                    "rating": {
                      "description": "The rating line as Facebook shows it, e.g. 94% recommend (14,553 reviews) or Not yet rated (1 review); businesses only",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "price_range": {
                      "description": "The price range the Intro card shows, e.g. $$; businesses only",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "type",
                    "page_id",
                    "url",
                    "name",
                    "description",
                    "is_verified",
                    "followers_count",
                    "followers_text",
                    "following_count",
                    "talking_about_count",
                    "profile_picture_url",
                    "cover_photo_url",
                    "category",
                    "email",
                    "phone",
                    "address",
                    "websites",
                    "rating",
                    "price_range"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/post": {
      "get": {
        "operationId": "facebook_post",
        "tags": [
          "Facebook"
        ],
        "summary": "Public post",
        "description": "A public post's text, author, engagement counts and attached media.\n\nUse it for one post's exact engagement: reactions by type, comment and share counts, and video views, with its text, author, media and link preview. Pass the post's URL. For the comments themselves, use post comments (facebook_post_comments).\n\nFacebook can hide or delay counts, and missing values stay null. Media links expire, so save what you need.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/post"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A public Facebook post URL: a /posts/ link, a reel, a video, a watch?v= link, or a permalink.php or story.php link. Group posts and share links don't work.",
            "schema": {
              "description": "A public Facebook post URL: a /posts/ link, a reel, a video, a watch?v= link, or a permalink.php or story.php link. Group posts and share links don't work.",
              "type": "string"
            },
            "example": "https://www.facebook.com/attn/posts/pfbid0j1Czf2gGDVqeQ8KiMLFm3pWN8GxsQmeRrVhimWDzMuKQoR8r4b1knNsejELmUgyhl"
          }
        ],
        "responses": {
          "200": {
            "description": "A public post's text, author, engagement counts and attached media.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "post_id": {
                      "type": "string",
                      "description": "Numeric post id."
                    },
                    "url": {
                      "type": "string",
                      "description": "The post's canonical Facebook permalink."
                    },
                    "text": {
                      "description": "The post's text, with line breaks kept; null for a post with only media.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "created_at": {
                      "description": "Post publication time as Unix seconds; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "author": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Author profile id."
                        },
                        "name": {
                          "type": "string",
                          "description": "Author display name."
                        },
                        "url": {
                          "description": "Author's public Facebook URL.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "url"
                      ],
                      "additionalProperties": false,
                      "description": "Who posted it (not someone mentioned in the post or its comments)."
                    },
                    "reaction_count": {
                      "description": "Total reactions to the post; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "comment_count": {
                      "description": "Total comments, as Facebook counts them; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "share_count": {
                      "description": "Shares; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "view_count": {
                      "description": "Video views; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "reactions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "description": "Facebook's localized reaction name, such as Like or Love.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "count": {
                            "description": "Number of reactions of this type; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "name",
                          "count"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Reactions by type. Empty when Facebook shows no breakdown."
                    },
                    "media": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "description": "Media id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "image",
                              "video"
                            ],
                            "description": "Media format."
                          },
                          "url": {
                            "description": "The photo's or video's page on Facebook.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "image_url": {
                            "description": "The image, or the video's thumbnail. The link expires.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "width": {
                            "description": "Media width in pixels; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "height": {
                            "description": "Media height in pixels; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "sd_url": {
                            "description": "Standard-definition video file URL; null for images. The link expires.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "hd_url": {
                            "description": "High-definition video file URL; null for images. The link expires.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "duration_s": {
                            "description": "Video duration in seconds; null for images; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "type",
                          "url",
                          "image_url",
                          "width",
                          "height",
                          "sd_url",
                          "hd_url",
                          "duration_s"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Images and videos attached to the post. Their links expire."
                    },
                    "link": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "url": {
                              "description": "The shared page's URL as the post links it; it can be a short link.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "title": {
                              "description": "The preview's title.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "description": {
                              "description": "The preview's description.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "image_url": {
                              "description": "The preview image, as Facebook stores it. The link expires.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "url",
                            "title",
                            "description",
                            "image_url"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The preview card of a link the post shares; null when it shares none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "post_id",
                    "url",
                    "text",
                    "created_at",
                    "author",
                    "reaction_count",
                    "comment_count",
                    "share_count",
                    "view_count",
                    "reactions",
                    "media",
                    "link"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/profile/posts": {
      "get": {
        "operationId": "facebook_profile_posts",
        "tags": [
          "Facebook"
        ],
        "summary": "Profile posts",
        "description": "A Facebook Page's or public person's latest posts, newest first, 5 per page.\n\nUse it to follow what a Page or person posts. Pass a profile `url` or a numeric `pageId`. You get the timeline a logged-out visitor sees: text, time, author, media, link previews, shared posts and engagement counts.\n\nCounts are rounded from 1,000 up, as the timeline shows them. For exact counts, pass a post's `url` to the post endpoint (facebook_post).\n\n**Pagination.** 5 posts per page, newest first. Pass `cursor` back for the next page. It's null on the last page.\n\nA profile Facebook hides from logged-out visitors (unknown, or a private person) returns 404 `not_found`, which is charged.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/profile-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A Facebook Page or personal profile URL, e.g. https://www.facebook.com/NASA. Also accepts profile.php?id=…, /people/<name>/<id> and /pages/<name>/<id> links. Group and share links don't work.",
            "schema": {
              "description": "A Facebook Page or personal profile URL, e.g. https://www.facebook.com/NASA. Also accepts profile.php?id=…, /people/<name>/<id> and /pages/<name>/<id> links. Group and share links don't work.",
              "type": "string"
            },
            "example": "https://www.facebook.com/NASA"
          },
          {
            "name": "pageId",
            "in": "query",
            "required": false,
            "description": "A numeric Page or profile id, e.g. `100044561550831` (NASA), instead of `url`. Ignored when `url` is set.",
            "schema": {
              "description": "A numeric Page or profile id, e.g. `100044561550831` (NASA), instead of `url`. Ignored when `url` is set.",
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, for the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, for the next page.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Facebook Page's or public person's latest posts, newest first, 5 per page.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "post_id": {
                            "type": "string",
                            "description": "Numeric post id."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post's permalink (a /posts/, /reel/ or /videos/ URL). Pass it to the post endpoint (facebook_post) for exact counts and the reaction breakdown."
                          },
                          "text": {
                            "description": "The post's text with line breaks; null for a media-only post or a bare share.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "created_at": {
                            "description": "Publication time as Unix seconds; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "description": "Author profile id.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "name": {
                                "description": "Author display name.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "url": {
                                "description": "Author's Facebook URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "url"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it: the Page or person whose timeline this is, or a co-author."
                          },
                          "reaction_count": {
                            "description": "Total reactions, as the timeline shows them. Exact below 1,000, rounded above (2.1K becomes 2100). The post endpoint has exact counts. Null when the timeline leaves it out.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "comment_count": {
                            "description": "Comments, as the timeline shows them. Exact below 1,000, rounded above (2.1K becomes 2100). The post endpoint has exact counts. Null when the timeline leaves it out.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "share_count": {
                            "description": "Shares, as the timeline shows them. Exact below 1,000, rounded above (2.1K becomes 2100). The post endpoint has exact counts. Null when the timeline leaves it out.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "media": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "description": "Media id.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "type": {
                                  "type": "string",
                                  "enum": [
                                    "image",
                                    "video"
                                  ],
                                  "description": "Media format."
                                },
                                "url": {
                                  "description": "The photo's or video's page on Facebook.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "image_url": {
                                  "description": "The image, or the video's thumbnail. The link expires.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "width": {
                                  "description": "Media width in pixels; null when Facebook doesn't show it publicly.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "height": {
                                  "description": "Media height in pixels; null when Facebook doesn't show it publicly.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "sd_url": {
                                  "description": "Standard-definition video file URL; null for images. The link expires.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "hd_url": {
                                  "description": "High-definition video file URL; null for images. The link expires.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "duration_s": {
                                  "description": "Video duration in seconds; null for images; null when Facebook doesn't show it publicly.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "id",
                                "type",
                                "url",
                                "image_url",
                                "width",
                                "height",
                                "sd_url",
                                "hd_url",
                                "duration_s"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Images and videos attached to the post. Their links expire."
                          },
                          "link": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "description": "The shared page's URL as the post links it; it can be a short link.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "title": {
                                    "description": "The preview's title.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "description": {
                                    "description": "The preview's description.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "image_url": {
                                    "description": "The preview image, as Facebook stores it. The link expires.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "url",
                                  "title",
                                  "description",
                                  "image_url"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The preview card of a link the post shares; null when it shares none."
                          },
                          "shared_post": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "description": "The shared post's or photo's permalink.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "text": {
                                    "description": "The shared post's text; null when it has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "created_at": {
                                    "description": "When the shared post was published, as Unix seconds; null when Facebook doesn't show it publicly.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "author": {
                                    "type": "object",
                                    "properties": {
                                      "name": {
                                        "description": "Its author's name.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "url": {
                                        "description": "Its author's Facebook URL.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "name",
                                      "url"
                                    ],
                                    "additionalProperties": false,
                                    "description": "The shared post's author."
                                  }
                                },
                                "required": [
                                  "url",
                                  "text",
                                  "created_at",
                                  "author"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The post this one shares, as the timeline shows it; null when it isn't a share."
                          }
                        },
                        "required": [
                          "post_id",
                          "url",
                          "text",
                          "created_at",
                          "author",
                          "reaction_count",
                          "comment_count",
                          "share_count",
                          "media",
                          "link",
                          "shared_post"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Posts, newest first."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page; null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/profile/events": {
      "get": {
        "operationId": "facebook_profile_events",
        "tags": [
          "Facebook"
        ],
        "summary": "Profile events",
        "description": "A Facebook Page's upcoming or past events: name, time, place and host.\n\nUse it to see what a venue, brand or organizer has coming up, or has hosted. Pass a Page or profile `url`. `type=upcoming` (the default) lists the next events, soonest first. `type=past` lists the latest ended ones, newest first.\n\nYou get up to 8 events and `total_count`, how many of that type the profile has. There's no cursor: Facebook refuses the requests that load more.\n\nA profile without events returns an empty list. One Facebook hides from logged-out visitors returns 404 `not_found` or 403 `not_public`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/profile-events"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A Facebook Page or personal profile URL, e.g. https://www.facebook.com/NASA. Also accepts profile.php?id=…, /people/<name>/<id> and /pages/<name>/<id> links. Group and share links don't work.",
            "schema": {
              "description": "A Facebook Page or personal profile URL, e.g. https://www.facebook.com/NASA. Also accepts profile.php?id=…, /people/<name>/<id> and /pages/<name>/<id> links. Group and share links don't work.",
              "type": "string"
            },
            "example": "https://www.facebook.com/930club"
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "`upcoming` for events still to come, `past` for ended ones.",
            "schema": {
              "description": "`upcoming` for events still to come, `past` for ended ones.",
              "default": "upcoming",
              "type": "string",
              "enum": [
                "upcoming",
                "past"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Facebook Page's upcoming or past events: name, time, place and host.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "events": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Event id."
                          },
                          "name": {
                            "type": "string",
                            "description": "Event name."
                          },
                          "url": {
                            "type": "string",
                            "description": "The event's Facebook URL."
                          },
                          "start_time": {
                            "description": "Start time as Unix seconds; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "day_time_text": {
                            "description": "When, as Facebook words it in the event's own time zone, e.g. Tue, Oct 20 at 7:00 PM EDT or Sat, Nov 7 - Nov 8.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "is_past": {
                            "description": "Whether the event has ended.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "is_online": {
                            "description": "Whether it's an online event.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "is_canceled": {
                            "description": "Whether the host canceled it.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "place": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "description": "The venue's name.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "city": {
                                    "description": "The venue's city.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "name",
                                  "city"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Where it happens; null for online events and events without a place."
                          },
                          "host": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "description": "Host profile id.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "name": {
                                    "description": "Host name.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "url": {
                                    "description": "Host's Facebook URL.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "name",
                                  "url"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Who created the event, when Facebook shows it; null for events listed by a ticketing partner."
                          },
                          "image_url": {
                            "description": "The cover image, a small crop. The link expires.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "url",
                          "start_time",
                          "day_time_text",
                          "is_past",
                          "is_online",
                          "is_canceled",
                          "place",
                          "host",
                          "image_url"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Up to 8 events: upcoming soonest first, past newest first."
                    },
                    "total_count": {
                      "description": "How many events of this type the profile has, as Facebook counts them; null if it doesn't say.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "events",
                    "total_count"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/facebook/post/comments": {
      "get": {
        "operationId": "facebook_post_comments",
        "tags": [
          "Facebook"
        ],
        "summary": "Post comments",
        "description": "A public post's top comments with their authors, times and reaction counts.\n\nUse it to read what people say under a post. Pass a public post, video or reel `url`. You get the comments a logged-out visitor sees first, Facebook's \"most relevant\" (usually 10), and `comment_count`, the post's total.\n\nThere's no cursor: Facebook refuses the requests that load more. Replies aren't included, but `reply_count` says how many each comment has.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/facebook/post-comments"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A public Facebook post URL: a /posts/ link, a reel, a video, a watch?v= link, or a permalink.php or story.php link. Group posts and share links don't work.",
            "schema": {
              "description": "A public Facebook post URL: a /posts/ link, a reel, a video, a watch?v= link, or a permalink.php or story.php link. Group posts and share links don't work.",
              "type": "string"
            },
            "example": "https://www.facebook.com/NASA/posts/pfbid0jzaSu71udHuXXhr9dE2wWtP3B23baKHFfD3dfAKXCoFQ3gCR8UpZa6iErzsiq77zl"
          }
        ],
        "responses": {
          "200": {
            "description": "A public post's top comments with their authors, times and reaction counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Numeric comment id."
                          },
                          "text": {
                            "description": "The comment's text; null for a sticker- or image-only comment.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "created_at": {
                            "description": "When it was posted, as Unix seconds; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "description": "Commenter id. For most people Facebook shows logged-out visitors a pfbid… id; for Pages, the numeric id.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "name": {
                                "description": "Commenter's display name.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "url": {
                                "description": "Commenter's Facebook URL; null when Facebook hides it from logged-out visitors.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "url"
                            ],
                            "additionalProperties": false,
                            "description": "Who wrote the comment."
                          },
                          "reaction_count": {
                            "description": "Reactions to the comment, when Facebook shows an exact number; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "reply_count": {
                            "description": "Replies to the comment; null when Facebook doesn't show it publicly.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "text",
                          "created_at",
                          "author",
                          "reaction_count",
                          "reply_count"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Top comments, most relevant first."
                    },
                    "comment_count": {
                      "description": "Total comments on the post; null when Facebook doesn't show it publicly.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "comments",
                    "comment_count"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reddit/subreddit": {
      "get": {
        "operationId": "reddit_subreddit_posts",
        "tags": [
          "Reddit"
        ],
        "summary": "Subreddit posts",
        "description": "A subreddit's feed (hot, new, top, rising or best), with titles, text, scores and comment counts.\n\nUse it to track what a community talks about: one page of its feed, sorted as on reddit.com, with each post's title, text, score and comment count. `timeframe` only applies with `sort=top`.\n\n**Pagination.** About 25 posts per page. Pass the response's `after` back as `after` for the next page; it's null at the end.\n\nMissing, private and banned subreddits return an empty `posts` list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/reddit/subreddit-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "subreddit",
            "in": "query",
            "required": true,
            "description": "Subreddit name without r/, e.g. `marketing`.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9_]{1,21}$",
              "description": "Subreddit name without r/, e.g. `marketing`."
            },
            "example": "marketing"
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Feed order, as on reddit.com.",
            "schema": {
              "description": "Feed order, as on reddit.com.",
              "default": "hot",
              "type": "string",
              "enum": [
                "best",
                "hot",
                "new",
                "top",
                "rising"
              ]
            }
          },
          {
            "name": "timeframe",
            "in": "query",
            "required": false,
            "description": "Time window for `sort=top`: hour, day, week, month, year or all.",
            "schema": {
              "description": "Time window for `sort=top`: hour, day, week, month, year or all.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "hour",
                "day",
                "week",
                "month",
                "year"
              ]
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "The `after` from the previous response, to get the next page.",
            "schema": {
              "description": "The `after` from the previous response, to get the next page.",
              "type": "string"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "`true` omits `selftext_html` for a smaller response.",
            "schema": {
              "description": "`true` omits `selftext_html` for a smaller response.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A subreddit's feed (hot, new, top, rising or best), with titles, text, scores and comment counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Post id, e.g. `1wtfnyr`."
                          },
                          "name": {
                            "type": "string",
                            "description": "Fullname, `t3_` + id. Subreddit listings paginate with it."
                          },
                          "title": {
                            "type": "string",
                            "description": "Post title."
                          },
                          "author": {
                            "description": "Username, without u/; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author_fullname": {
                            "description": "Author's account fullname, `t2_` + id; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "subreddit": {
                            "type": "string",
                            "description": "Subreddit name without r/, e.g. `marketing`."
                          },
                          "subreddit_id": {
                            "description": "Subreddit fullname, `t5_` + id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "subreddit_name_prefixed": {
                            "description": "Subreddit name with the r/ prefix, e.g. `r/marketing`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "permalink": {
                            "type": "string",
                            "description": "Path on reddit.com; prepend https://www.reddit.com."
                          },
                          "url": {
                            "type": "string",
                            "description": "The link a link post points to (the original post for crossposts), or the post itself for text posts."
                          },
                          "url_overridden_by_dest": {
                            "description": "Outbound link, on link posts only.",
                            "type": "string"
                          },
                          "domain": {
                            "description": "`self.<subreddit>` for text posts, else the linked site.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "selftext": {
                            "type": "string",
                            "description": "Post body as plain text. Empty for link, media and crosspost posts."
                          },
                          "selftext_html": {
                            "description": "Post body as HTML. Omitted with trim=true.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "score": {
                            "type": "number",
                            "description": "Upvotes minus downvotes."
                          },
                          "ups": {
                            "type": "number",
                            "description": "Same as score."
                          },
                          "upvote_ratio": {
                            "description": "Share of votes that are upvotes, 0–1.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "num_comments": {
                            "type": "number",
                            "description": "Comment count when fetched."
                          },
                          "created": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "created_utc": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "is_self": {
                            "type": "boolean",
                            "description": "A text post rather than a link."
                          },
                          "is_video": {
                            "type": "boolean",
                            "description": "A video post."
                          },
                          "is_gallery": {
                            "description": "Present (true) on image galleries; absent otherwise.",
                            "type": "boolean"
                          },
                          "over_18": {
                            "type": "boolean",
                            "description": "Marked NSFW."
                          },
                          "spoiler": {
                            "type": "boolean",
                            "description": "Marked as a spoiler."
                          },
                          "stickied": {
                            "type": "boolean",
                            "description": "Pinned by moderators."
                          },
                          "locked": {
                            "type": "boolean",
                            "description": "Locked: no new comments allowed."
                          },
                          "link_flair_text": {
                            "description": "Post flair, e.g. \"Question\"; null without flair.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "link_flair_background_color": {
                            "description": "Flair color as a hex code, e.g. #94E044; null without flair.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnail": {
                            "description": "Preview image URL; null for posts without media.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "total_awards_received": {
                            "type": "number",
                            "description": "Awards the post received."
                          },
                          "crosspost_parent_list": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "description": "The original post's id, e.g. `1ww1x9d`."
                                    },
                                    "name": {
                                      "type": "string",
                                      "description": "Its fullname, `t3_` + id."
                                    },
                                    "title": {
                                      "type": "string",
                                      "description": "Its title."
                                    },
                                    "subreddit": {
                                      "type": "string",
                                      "description": "Its subreddit, without r/."
                                    },
                                    "subreddit_name_prefixed": {
                                      "type": "string",
                                      "description": "Its subreddit with the r/ prefix, e.g. `r/soccer`."
                                    },
                                    "permalink": {
                                      "type": "string",
                                      "description": "Its path on reddit.com. Pass it to post comments for its body and replies."
                                    },
                                    "score": {
                                      "description": "Its upvotes minus downvotes; null if the card doesn't show them.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "num_comments": {
                                      "description": "Its comment count; null if the card doesn't show it.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "created_utc": {
                                      "description": "Posted at, Unix seconds; null if the card doesn't show it.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "title",
                                    "subreddit",
                                    "subreddit_name_prefixed",
                                    "permalink",
                                    "score",
                                    "num_comments",
                                    "created_utc"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "On crossposts, the original post as a one-item list (Reddit's shape), with what the card shows: no author or body. null otherwise."
                          },
                          "poll_data": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "options": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "description": "Option id; null on closed polls, which reddit.com shows without ids.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "text": {
                                          "type": "string",
                                          "description": "Option text."
                                        },
                                        "vote_count": {
                                          "description": "Votes for this option; null while the poll is open (Reddit shows them once it closes).",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "id",
                                        "text",
                                        "vote_count"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Options in display order."
                                  },
                                  "total_vote_count": {
                                    "description": "Votes cast.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "voting_end_timestamp": {
                                    "description": "When voting closes, Unix milliseconds as in Reddit's JSON; null once closed.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "options",
                                  "total_vote_count",
                                  "voting_end_timestamp"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Poll options and votes; null for other posts."
                          },
                          "gallery_data": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "items": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "url": {
                                          "type": "string",
                                          "description": "Full-size image URL (i.redd.it), or a preview if that's all the page has."
                                        },
                                        "width": {
                                          "description": "Original width in pixels.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        },
                                        "height": {
                                          "description": "Original height in pixels.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "url",
                                        "width",
                                        "height"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Images in gallery order."
                                  }
                                },
                                "required": [
                                  "items"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Every image of a gallery post (on crossposts, the original's); null otherwise."
                          },
                          "media": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "reddit_video": {
                                    "type": "object",
                                    "properties": {
                                      "hls_url": {
                                        "type": "string",
                                        "description": "HLS playlist with video and audio, as reddit.com plays it."
                                      },
                                      "fallback_url": {
                                        "description": "Largest MP4 with audio. A signed link that expires within hours; null when reddit.com offers none.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "width": {
                                        "description": "That MP4's width in pixels.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "height": {
                                        "description": "That MP4's height in pixels.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "duration": {
                                        "description": "Length in seconds.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "hls_url",
                                      "fallback_url",
                                      "width",
                                      "height",
                                      "duration"
                                    ],
                                    "additionalProperties": false,
                                    "description": "The video's streams."
                                  }
                                },
                                "required": [
                                  "reddit_video"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Reddit-hosted video (v.redd.it; on crossposts, the original's); null otherwise, including YouTube and other embeds."
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "title",
                          "author",
                          "author_fullname",
                          "subreddit",
                          "subreddit_id",
                          "subreddit_name_prefixed",
                          "permalink",
                          "url",
                          "domain",
                          "selftext",
                          "score",
                          "ups",
                          "upvote_ratio",
                          "num_comments",
                          "created",
                          "created_utc",
                          "is_self",
                          "is_video",
                          "over_18",
                          "spoiler",
                          "stickied",
                          "locked",
                          "link_flair_text",
                          "link_flair_background_color",
                          "thumbnail",
                          "total_awards_received",
                          "crosspost_parent_list",
                          "poll_data",
                          "gallery_data",
                          "media"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of posts, in feed order."
                    },
                    "after": {
                      "description": "Pass as `after` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "after"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reddit/subreddit/details": {
      "get": {
        "operationId": "reddit_subreddit_details",
        "tags": [
          "Reddit"
        ],
        "summary": "Subreddit details",
        "description": "A community's size, activity, description, rules and images.\n\nUse it to size up a community before you post: the weekly visitors and contributions reddit.com shows, its description, numbered rules, icon, banner and creation date. Pass `subreddit` or a Reddit `url`.\n\nThere's no subscriber count, because reddit.com no longer shows one. `weekly_active_users` is the closest measure.\n\nUnknown or private subreddits return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/reddit/subreddit-details"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "subreddit",
            "in": "query",
            "required": false,
            "description": "Subreddit name (e.g. `marketing`) or URL. Required unless you pass `url`.",
            "schema": {
              "description": "Subreddit name (e.g. `marketing`) or URL. Required unless you pass `url`.",
              "type": "string"
            },
            "example": "marketing"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Any Reddit URL containing /r/<name>, e.g. `https://www.reddit.com/r/marketing/`.",
            "schema": {
              "description": "Any Reddit URL containing /r/<name>, e.g. `https://www.reddit.com/r/marketing/`.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A community's size, activity, description, rules and images.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "subreddit_id": {
                      "type": "string",
                      "description": "Fullname, `t5_…`."
                    },
                    "display_name": {
                      "type": "string",
                      "description": "Name with Reddit's capitalization."
                    },
                    "description": {
                      "type": "string",
                      "description": "The public one-paragraph description."
                    },
                    "rules": {
                      "type": "string",
                      "description": "Community rules as numbered plain text: \"1. Title\\nDetails\\n\\n2. …\"."
                    },
                    "weekly_active_users": {
                      "description": "Weekly visitors, as shown on the community page.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "weekly_contributions": {
                      "description": "Posts plus comments in the last week.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "icon_img": {
                      "description": "Community icon URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "header_img": {
                      "description": "Banner image URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "created_at": {
                      "type": "string",
                      "description": "When the subreddit was created, ISO 8601."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "subreddit_id",
                    "display_name",
                    "description",
                    "rules",
                    "weekly_active_users",
                    "weekly_contributions",
                    "icon_img",
                    "header_img",
                    "created_at"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reddit/subreddit/search": {
      "get": {
        "operationId": "reddit_subreddit_search",
        "tags": [
          "Reddit"
        ],
        "summary": "Subreddit search",
        "description": "Search one subreddit's posts by keyword, returned as compact result cards.\n\nUse it to find what one community says about a product, a competitor or a problem. It works like the search box on a community page. Each result has its title, `votes`, `num_comments`, `created_at` and subreddit, but not the post's text.\n\nFor the text and replies, pass a result's `url` to post comments (`reddit_post_comments`).\n\n**Pagination.** Pass the response's `cursor` back as `cursor` for the next page; it's null at the end.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/reddit/subreddit-search"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "subreddit",
            "in": "query",
            "required": true,
            "description": "Subreddit name without r/, e.g. `marketing`.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9_]{1,21}$",
              "description": "Subreddit name without r/, e.g. `marketing`."
            },
            "example": "marketing"
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Keywords. Leave empty to list the subreddit's posts in `sort` order.",
            "schema": {
              "default": "",
              "description": "Keywords. Leave empty to list the subreddit's posts in `sort` order.",
              "type": "string"
            },
            "example": "AI video"
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Result order. `comments` = most commented.",
            "schema": {
              "description": "Result order. `comments` = most commented.",
              "default": "relevance",
              "type": "string",
              "enum": [
                "relevance",
                "hot",
                "top",
                "new",
                "comments"
              ]
            }
          },
          {
            "name": "timeframe",
            "in": "query",
            "required": false,
            "description": "Only posts from the last hour, day, week, month, year, or all time.",
            "schema": {
              "description": "Only posts from the last hour, day, week, month, year, or all time.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "hour",
                "day",
                "week",
                "month",
                "year"
              ]
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search one subreddit's posts by keyword, returned as compact result cards.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Fullname, e.g. `t3_1t673is`."
                          },
                          "post_id": {
                            "type": "string",
                            "description": "Same as id."
                          },
                          "title": {
                            "type": "string",
                            "description": "Post title."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on reddit.com. Pass it to post comments for the body and replies."
                          },
                          "permalink": {
                            "type": "string",
                            "description": "Path on reddit.com."
                          },
                          "votes": {
                            "type": "number",
                            "description": "Score (upvotes minus downvotes)."
                          },
                          "num_comments": {
                            "type": "number",
                            "description": "Comment count when fetched."
                          },
                          "created_at": {
                            "type": "string",
                            "description": "Posted at, e.g. `2026-05-07T10:59:35.000+0000`."
                          },
                          "created_at_iso": {
                            "type": "string",
                            "description": "Posted at, ISO 8601."
                          },
                          "nsfw": {
                            "type": "boolean",
                            "description": "Marked NSFW."
                          },
                          "spoiler": {
                            "type": "boolean",
                            "description": "Marked as a spoiler."
                          },
                          "is_crosspost": {
                            "type": "boolean",
                            "description": "Always false: search results don't say whether a post is a crosspost."
                          },
                          "thumbnail": {
                            "description": "Preview image URL; null for posts without media.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnail_blurred": {
                            "type": "boolean",
                            "description": "Always false: search results don't include it."
                          },
                          "position": {
                            "type": "number",
                            "description": "Rank in the results, from 0."
                          },
                          "relative_position": {
                            "type": "number",
                            "description": "Rank as Reddit reports it; usually equal to position."
                          },
                          "subreddit": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "description": "Subreddit fullname, `t5_` + id.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "name": {
                                "type": "string",
                                "description": "Subreddit name without r/."
                              },
                              "nsfw": {
                                "type": "boolean",
                                "description": "The subreddit is NSFW."
                              },
                              "quarantined": {
                                "type": "boolean",
                                "description": "The subreddit is quarantined."
                              },
                              "icon": {
                                "description": "Subreddit icon URL, when the result shows one.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "banner": {
                                "description": "Always null here; get it from subreddit details.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "description": {
                                "description": "Always null here; get it from subreddit details.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "weekly_visitors": {
                                "description": "Always null here; get it from subreddit details.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "weekly_contributions": {
                                "description": "Always null here; get it from subreddit details.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "nsfw",
                              "quarantined",
                              "icon",
                              "banner",
                              "description",
                              "weekly_visitors",
                              "weekly_contributions"
                            ],
                            "additionalProperties": false,
                            "description": "The subreddit the post is in."
                          }
                        },
                        "required": [
                          "id",
                          "post_id",
                          "title",
                          "url",
                          "permalink",
                          "votes",
                          "num_comments",
                          "created_at",
                          "created_at_iso",
                          "nsfw",
                          "spoiler",
                          "is_crosspost",
                          "thumbnail",
                          "thumbnail_blurred",
                          "position",
                          "relative_position",
                          "subreddit"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching posts, best match first (or in `sort` order)."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reddit/search": {
      "get": {
        "operationId": "reddit_search",
        "tags": [
          "Reddit"
        ],
        "summary": "Search Reddit",
        "description": "Search all of Reddit for posts matching a keyword.\n\nUse it for brand monitoring and to find where a topic is discussed. It searches posts across all of Reddit, like reddit.com/search, and returns each post's title, author, subreddit, score, comment count and date. It doesn't search comments.\n\nResults have no body text or link. For the full post, pass `https://www.reddit.com` + `permalink` as `url` to post comments (`reddit_post_comments`).\n\n**Pagination.** Pass the response's `after` back as `after` for the next page; it's null at the end.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/reddit/search"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Keywords, e.g. `claude mcp`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "description": "Keywords, e.g. `claude mcp`."
            },
            "example": "claude mcp"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "What to search. Only `posts` for now; comment search isn't supported yet.",
            "schema": {
              "description": "What to search. Only `posts` for now; comment search isn't supported yet.",
              "default": "posts",
              "type": "string",
              "enum": [
                "posts"
              ]
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Result order.",
            "schema": {
              "description": "Result order.",
              "default": "relevance",
              "type": "string",
              "enum": [
                "relevance",
                "new",
                "top",
                "comment_count"
              ]
            }
          },
          {
            "name": "timeframe",
            "in": "query",
            "required": false,
            "description": "Only posts from the last hour, day, week, month, year, or all time.",
            "schema": {
              "description": "Only posts from the last hour, day, week, month, year, or all time.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "hour",
                "day",
                "week",
                "month",
                "year"
              ]
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "The `after` from the previous response, to get the next page.",
            "schema": {
              "description": "The `after` from the previous response, to get the next page.",
              "type": "string"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Has no effect here: search results have no HTML body to drop.",
            "schema": {
              "description": "Has no effect here: search results have no HTML body to drop.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search all of Reddit for posts matching a keyword.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Post id. Pass the post's URL to post comments for the full post."
                          },
                          "name": {
                            "type": "string",
                            "description": "Fullname, `t3_` + id."
                          },
                          "title": {
                            "type": "string",
                            "description": "Post title."
                          },
                          "author": {
                            "description": "Username, without u/; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author_fullname": {
                            "description": "Author's account fullname, `t2_` + id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "subreddit": {
                            "type": "string",
                            "description": "Subreddit name without r/."
                          },
                          "subreddit_id": {
                            "description": "Subreddit fullname, `t5_` + id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "subreddit_name_prefixed": {
                            "type": "string",
                            "description": "Subreddit name with the r/ prefix, e.g. `r/ClaudeAI`."
                          },
                          "quarantine": {
                            "type": "boolean",
                            "description": "The subreddit is quarantined."
                          },
                          "permalink": {
                            "description": "Path on reddit.com; prepend https://www.reddit.com.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "score": {
                            "type": "number",
                            "description": "Upvotes minus downvotes."
                          },
                          "ups": {
                            "type": "number",
                            "description": "Same as score."
                          },
                          "num_comments": {
                            "type": "number",
                            "description": "Comment count when fetched."
                          },
                          "created": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "created_utc": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "created_at_iso": {
                            "type": "string",
                            "description": "Posted at, ISO 8601."
                          },
                          "over_18": {
                            "type": "boolean",
                            "description": "Marked NSFW."
                          },
                          "spoiler": {
                            "type": "boolean",
                            "description": "Marked as a spoiler."
                          },
                          "thumbnail": {
                            "description": "Preview image URL; null for posts without media.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "title",
                          "author",
                          "author_fullname",
                          "subreddit",
                          "subreddit_id",
                          "subreddit_name_prefixed",
                          "quarantine",
                          "permalink",
                          "score",
                          "ups",
                          "num_comments",
                          "created",
                          "created_utc",
                          "created_at_iso",
                          "over_18",
                          "spoiler",
                          "thumbnail"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching posts, in `sort` order."
                    },
                    "after": {
                      "description": "Pass as `after` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "after"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reddit/post/comments": {
      "get": {
        "operationId": "reddit_post_comments",
        "tags": [
          "Reddit"
        ],
        "summary": "Post comments",
        "description": "A Reddit post and its comment thread, with nested replies.\n\nUse it to read a thread and learn what people really think: objections, feature requests, the words customers use. You get the post and its comments, best first, with replies nested under `replies.items`.\n\n**Loading more.** Reddit loads long threads in batches. Wherever `more.has_more` is true (at the top level, or inside any comment's `replies`), pass that `more.next_cursor` as `cursor`, with the same `url`, to load that batch. Those responses have `post: null`.\n\nUnknown or removed posts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/reddit/post-comments"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The post's URL, e.g. `https://www.reddit.com/r/marketing/comments/1wsx466/`. A /r/… path works too.",
            "schema": {
              "type": "string",
              "description": "The post's URL, e.g. `https://www.reddit.com/r/marketing/comments/1wsx466/`. A /r/… path works too."
            },
            "example": "https://www.reddit.com/r/marketing/comments/1wsx466/want_to_become_an_llm_expert_in_marketing_where/"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "A `more.next_cursor` from a previous response, to load that batch of comments.",
            "schema": {
              "description": "A `more.next_cursor` from a previous response, to load that batch of comments.",
              "type": "string"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "`true` omits the post's `selftext_html`.",
            "schema": {
              "description": "`true` omits the post's `selftext_html`.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Reddit post and its comment thread, with nested replies.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "post": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Post id, e.g. `1wtfnyr`."
                            },
                            "name": {
                              "type": "string",
                              "description": "Fullname, `t3_` + id. Subreddit listings paginate with it."
                            },
                            "title": {
                              "type": "string",
                              "description": "Post title."
                            },
                            "author": {
                              "description": "Username, without u/; null if unknown.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "author_fullname": {
                              "description": "Author's account fullname, `t2_` + id; null if unknown.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "subreddit": {
                              "type": "string",
                              "description": "Subreddit name without r/, e.g. `marketing`."
                            },
                            "subreddit_id": {
                              "description": "Subreddit fullname, `t5_` + id.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "subreddit_name_prefixed": {
                              "description": "Subreddit name with the r/ prefix, e.g. `r/marketing`.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "permalink": {
                              "type": "string",
                              "description": "Path on reddit.com; prepend https://www.reddit.com."
                            },
                            "url": {
                              "type": "string",
                              "description": "The link a link post points to (the original post for crossposts), or the post itself for text posts."
                            },
                            "url_overridden_by_dest": {
                              "description": "Outbound link, on link posts only.",
                              "type": "string"
                            },
                            "domain": {
                              "description": "`self.<subreddit>` for text posts, else the linked site.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "selftext": {
                              "type": "string",
                              "description": "Post body as plain text. Empty for link, media and crosspost posts."
                            },
                            "selftext_html": {
                              "description": "Post body as HTML. Omitted with trim=true.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "score": {
                              "type": "number",
                              "description": "Upvotes minus downvotes."
                            },
                            "ups": {
                              "type": "number",
                              "description": "Same as score."
                            },
                            "upvote_ratio": {
                              "description": "Share of votes that are upvotes, 0–1.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "num_comments": {
                              "type": "number",
                              "description": "Comment count when fetched."
                            },
                            "created": {
                              "type": "number",
                              "description": "Posted at, Unix seconds."
                            },
                            "created_utc": {
                              "type": "number",
                              "description": "Posted at, Unix seconds."
                            },
                            "is_self": {
                              "type": "boolean",
                              "description": "A text post rather than a link."
                            },
                            "is_video": {
                              "type": "boolean",
                              "description": "A video post."
                            },
                            "is_gallery": {
                              "description": "Present (true) on image galleries; absent otherwise.",
                              "type": "boolean"
                            },
                            "over_18": {
                              "type": "boolean",
                              "description": "Marked NSFW."
                            },
                            "spoiler": {
                              "type": "boolean",
                              "description": "Marked as a spoiler."
                            },
                            "stickied": {
                              "type": "boolean",
                              "description": "Pinned by moderators."
                            },
                            "locked": {
                              "type": "boolean",
                              "description": "Locked: no new comments allowed."
                            },
                            "link_flair_text": {
                              "description": "Post flair, e.g. \"Question\"; null without flair.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "link_flair_background_color": {
                              "description": "Flair color as a hex code, e.g. #94E044; null without flair.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "thumbnail": {
                              "description": "Preview image URL; null for posts without media.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "total_awards_received": {
                              "type": "number",
                              "description": "Awards the post received."
                            },
                            "crosspost_parent_list": {
                              "anyOf": [
                                {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "string",
                                        "description": "The original post's id, e.g. `1ww1x9d`."
                                      },
                                      "name": {
                                        "type": "string",
                                        "description": "Its fullname, `t3_` + id."
                                      },
                                      "title": {
                                        "type": "string",
                                        "description": "Its title."
                                      },
                                      "subreddit": {
                                        "type": "string",
                                        "description": "Its subreddit, without r/."
                                      },
                                      "subreddit_name_prefixed": {
                                        "type": "string",
                                        "description": "Its subreddit with the r/ prefix, e.g. `r/soccer`."
                                      },
                                      "permalink": {
                                        "type": "string",
                                        "description": "Its path on reddit.com. Pass it to post comments for its body and replies."
                                      },
                                      "score": {
                                        "description": "Its upvotes minus downvotes; null if the card doesn't show them.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "num_comments": {
                                        "description": "Its comment count; null if the card doesn't show it.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "created_utc": {
                                        "description": "Posted at, Unix seconds; null if the card doesn't show it.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "name",
                                      "title",
                                      "subreddit",
                                      "subreddit_name_prefixed",
                                      "permalink",
                                      "score",
                                      "num_comments",
                                      "created_utc"
                                    ],
                                    "additionalProperties": false
                                  }
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "On crossposts, the original post as a one-item list (Reddit's shape), with what the card shows: no author or body. null otherwise."
                            },
                            "poll_data": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "options": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "description": "Option id; null on closed polls, which reddit.com shows without ids.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "text": {
                                            "type": "string",
                                            "description": "Option text."
                                          },
                                          "vote_count": {
                                            "description": "Votes for this option; null while the poll is open (Reddit shows them once it closes).",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "text",
                                          "vote_count"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "Options in display order."
                                    },
                                    "total_vote_count": {
                                      "description": "Votes cast.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "voting_end_timestamp": {
                                      "description": "When voting closes, Unix milliseconds as in Reddit's JSON; null once closed.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "options",
                                    "total_vote_count",
                                    "voting_end_timestamp"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Poll options and votes; null for other posts."
                            },
                            "gallery_data": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "items": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "url": {
                                            "type": "string",
                                            "description": "Full-size image URL (i.redd.it), or a preview if that's all the page has."
                                          },
                                          "width": {
                                            "description": "Original width in pixels.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          },
                                          "height": {
                                            "description": "Original height in pixels.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "url",
                                          "width",
                                          "height"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "Images in gallery order."
                                    }
                                  },
                                  "required": [
                                    "items"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Every image of a gallery post (on crossposts, the original's); null otherwise."
                            },
                            "media": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "reddit_video": {
                                      "type": "object",
                                      "properties": {
                                        "hls_url": {
                                          "type": "string",
                                          "description": "HLS playlist with video and audio, as reddit.com plays it."
                                        },
                                        "fallback_url": {
                                          "description": "Largest MP4 with audio. A signed link that expires within hours; null when reddit.com offers none.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "width": {
                                          "description": "That MP4's width in pixels.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        },
                                        "height": {
                                          "description": "That MP4's height in pixels.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        },
                                        "duration": {
                                          "description": "Length in seconds.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "hls_url",
                                        "fallback_url",
                                        "width",
                                        "height",
                                        "duration"
                                      ],
                                      "additionalProperties": false,
                                      "description": "The video's streams."
                                    }
                                  },
                                  "required": [
                                    "reddit_video"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Reddit-hosted video (v.redd.it; on crossposts, the original's); null otherwise, including YouTube and other embeds."
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "title",
                            "author",
                            "author_fullname",
                            "subreddit",
                            "subreddit_id",
                            "subreddit_name_prefixed",
                            "permalink",
                            "url",
                            "domain",
                            "selftext",
                            "score",
                            "ups",
                            "upvote_ratio",
                            "num_comments",
                            "created",
                            "created_utc",
                            "is_self",
                            "is_video",
                            "over_18",
                            "spoiler",
                            "stickied",
                            "locked",
                            "link_flair_text",
                            "link_flair_background_color",
                            "thumbnail",
                            "total_awards_received",
                            "crosspost_parent_list",
                            "poll_data",
                            "gallery_data",
                            "media"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The post. null on cursor responses."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RedditComment"
                      },
                      "description": "Top-level comments, each with nested `replies`."
                    },
                    "more": {
                      "type": "object",
                      "properties": {
                        "has_more": {
                          "type": "boolean",
                          "description": "Whether there are more comments to load here."
                        },
                        "next_cursor": {
                          "description": "Pass as `cursor` (with the same url) to load them; null when has_more is false.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "has_more",
                        "next_cursor"
                      ],
                      "additionalProperties": false,
                      "description": "More comments that weren't loaded yet."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "post",
                    "comments",
                    "more"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/video": {
      "get": {
        "operationId": "youtube_video",
        "tags": [
          "YouTube"
        ],
        "summary": "Video details",
        "description": "A video's or Short's title, description, exact views and likes, publish date, length, tags, chapters and channel.\n\nUse it to track how a video performs or to pull its metadata: exact view and like counts, the full description and its links, tags, category, chapters, the \"Most replayed\" graph and the videos YouTube recommends next. Works for Shorts too (`type: \"short\"`).\n\nThe comment count is rounded the way YouTube shows it; video comments returns the exact total. For what's said in the video, use video transcript.\n\nNow and then YouTube's player doesn't answer. Then `type`, `durationMs`, `durationFormatted`, `keywords`, `genre`, `publishDate`, `uploadDate`, `isFamilySafe` and `isUnlisted` are null, and a non-English `title` and `description` may come back in YouTube's English translation. Everything else is still filled in.\n\nPrivate, removed and unknown videos return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/video"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL (watch, youtu.be, /shorts/, /live/ or /embed/ links all work) or its 11-character id, e.g. `https://www.youtube.com/watch?v=dQw4w9WgXcQ`.",
            "schema": {
              "type": "string",
              "description": "The video's URL (watch, youtu.be, /shorts/, /live/ or /embed/ links all work) or its 11-character id, e.g. `https://www.youtube.com/watch?v=dQw4w9WgXcQ`."
            },
            "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
          }
        ],
        "responses": {
          "200": {
            "description": "A video's or Short's title, description, exact views and likes, publish date, length, tags, chapters and channel.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Video id, e.g. `dQw4w9WgXcQ`."
                    },
                    "type": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "video",
                            "short"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "`short` for YouTube Shorts, else `video`. null in the rare case the player details were unavailable (see `durationMs`)."
                    },
                    "url": {
                      "type": "string",
                      "description": "Canonical link: /shorts/<id> for Shorts, /watch?v=<id> otherwise."
                    },
                    "title": {
                      "type": "string",
                      "description": "Video title, as the creator wrote it (not YouTube's English translation)."
                    },
                    "description": {
                      "type": "string",
                      "description": "Full description as the creator wrote it, plain text, links in full."
                    },
                    "descriptionLinks": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "text": {
                            "type": "string",
                            "description": "The link as it appears in the description; the full URL where YouTube shows a chip or shortens it."
                          },
                          "url": {
                            "type": "string",
                            "description": "Where it goes (YouTube's redirect wrapper removed)."
                          }
                        },
                        "required": [
                          "text",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Links in the description, in order: websites and other YouTube videos (not hashtags, mentions or timestamps)."
                    },
                    "thumbnail": {
                      "type": "string",
                      "description": "Largest thumbnail URL."
                    },
                    "viewCountText": {
                      "description": "Views as YouTube shows them, e.g. \"1,821,613,271 views\", or \"8,698 watching now\" during a live stream.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "viewCountInt": {
                      "description": "Exact view count (total views, also during a live stream).",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "likeCountText": {
                      "description": "Likes as YouTube shows them, e.g. \"19M\"; null when the creator hides likes.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "likeCountInt": {
                      "description": "Exact like count. null when the creator hides likes.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "commentCountText": {
                      "description": "Comments as YouTube shows them, e.g. \"2.4M\"; null when comments are off.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "commentCountInt": {
                      "description": "Comment count from that text, so rounded above 1,000 (2.4M → 2400000). The comments endpoint returns the exact total.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "publishDate": {
                      "description": "Published at, ISO 8601 with YouTube's offset, e.g. `2009-10-24T23:57:33-07:00`. null if unavailable.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "uploadDate": {
                      "description": "Uploaded at, ISO 8601 (differs from publishDate for scheduled videos and premieres). null if unavailable.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "publishDateText": {
                      "description": "The date line under the video, e.g. \"Oct 24, 2009\" or \"Premiered 3 hours ago\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "channel": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "description": "Channel id, `UC…`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "url": {
                          "description": "Channel page, e.g. `https://www.youtube.com/@RickAstleyYT`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "handle": {
                          "description": "Handle without the @, e.g. `RickAstleyYT`; null if YouTube shows none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "title": {
                          "description": "Channel name.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "subscriberCountText": {
                          "description": "Subscribers as YouTube shows them, e.g. \"4.55M subscribers\".",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "subscriberCount": {
                          "description": "Subscribers as a number, from that rounded text (4.55M → 4550000).",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "isVerified": {
                          "type": "boolean",
                          "description": "Has a verified or official artist badge."
                        },
                        "avatar": {
                          "description": "Channel avatar URL.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "url",
                        "handle",
                        "title",
                        "subscriberCountText",
                        "subscriberCount",
                        "isVerified",
                        "avatar"
                      ],
                      "additionalProperties": false,
                      "description": "The channel that posted it."
                    },
                    "chapters": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "title": {
                            "type": "string",
                            "description": "Chapter title."
                          },
                          "startMs": {
                            "type": "number",
                            "description": "Where the chapter starts, in milliseconds from the start of the video."
                          },
                          "thumbnail": {
                            "description": "Chapter thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "title",
                          "startMs",
                          "thumbnail"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Chapters from the description (or YouTube's automatic ones), in order. Empty if the video has none."
                    },
                    "keywords": {
                      "anyOf": [
                        {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The creator's tags. null if unavailable."
                    },
                    "genre": {
                      "description": "YouTube category, e.g. \"Music\" or \"Education\". null if unavailable.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "durationMs": {
                      "description": "Length in milliseconds. null during a live stream, and if unavailable. This and the other fields marked \"if unavailable\" come from YouTube's player, which now and then doesn't answer. The rest of the response is still complete then.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "durationFormatted": {
                      "description": "Length as `HH:MM:SS`, e.g. \"00:03:33\". null during a live stream or if unavailable.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "isFamilySafe": {
                      "description": "YouTube considers it family safe. null if unavailable.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "isUnlisted": {
                      "description": "Unlisted (only people with the link can find it). null if unavailable.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "most_replayed": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "markers": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "startMillis": {
                                    "type": "number",
                                    "description": "Start of this slice of the video, in milliseconds."
                                  },
                                  "durationMillis": {
                                    "type": "number",
                                    "description": "Length of the slice, in milliseconds."
                                  },
                                  "intensityScoreNormalized": {
                                    "type": "number",
                                    "description": "How often this slice is replayed, 0–1 (1 = the most replayed slice)."
                                  }
                                },
                                "required": [
                                  "startMillis",
                                  "durationMillis",
                                  "intensityScoreNormalized"
                                ],
                                "additionalProperties": false
                              },
                              "description": "The replay graph over the timeline, usually 100 equal slices."
                            },
                            "ranges": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "visibleTimeRangeStartMillis": {
                                    "type": "number",
                                    "description": "Start of the highlighted range, in milliseconds."
                                  },
                                  "visibleTimeRangeEndMillis": {
                                    "type": "number",
                                    "description": "End of the highlighted range, in milliseconds."
                                  },
                                  "decorationTimeMillis": {
                                    "type": "number",
                                    "description": "The peak YouTube points at, in milliseconds."
                                  },
                                  "label": {
                                    "description": "YouTube's label, e.g. \"Most replayed\".",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "visibleTimeRangeStartMillis",
                                  "visibleTimeRangeEndMillis",
                                  "decorationTimeMillis",
                                  "label"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Ranges YouTube highlights as most replayed."
                            }
                          },
                          "required": [
                            "markers",
                            "ranges"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The \"Most replayed\" graph. null when YouTube doesn't show one (newer or less-watched videos)."
                    },
                    "watchNextVideos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Video id."
                          },
                          "title": {
                            "description": "Video title (YouTube may translate non-English titles into English).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnail": {
                            "description": "Thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "channel": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "description": "Channel id, `UC…`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "url": {
                                "description": "Channel page, e.g. `https://www.youtube.com/@RickAstleyYT`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "handle": {
                                "description": "Handle without the @, e.g. `RickAstleyYT`; null if YouTube shows none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "title": {
                                "description": "Channel name.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "url",
                              "handle",
                              "title"
                            ],
                            "additionalProperties": false,
                            "description": "The channel that posted it."
                          },
                          "publishedTimeText": {
                            "description": "When it was posted, relative, e.g. \"3 months ago\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountText": {
                            "description": "Views as YouTube shows them, e.g. \"3.9M\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountInt": {
                            "description": "Views from that rounded text (3.9M → 3900000).",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "lengthText": {
                            "description": "Length as shown on the thumbnail, e.g. \"4:05\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthInSeconds": {
                            "description": "Length in seconds.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "videoUrl": {
                            "type": "string",
                            "description": "Link to the video."
                          }
                        },
                        "required": [
                          "id",
                          "title",
                          "thumbnail",
                          "channel",
                          "publishedTimeText",
                          "viewCountText",
                          "viewCountInt",
                          "lengthText",
                          "lengthInSeconds",
                          "videoUrl"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The \"Up next\" videos YouTube recommends beside this one (videos only, no mixes or playlists)."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "type",
                    "url",
                    "title",
                    "description",
                    "descriptionLinks",
                    "thumbnail",
                    "viewCountText",
                    "viewCountInt",
                    "likeCountText",
                    "likeCountInt",
                    "commentCountText",
                    "commentCountInt",
                    "publishDate",
                    "uploadDate",
                    "publishDateText",
                    "channel",
                    "chapters",
                    "keywords",
                    "genre",
                    "durationMs",
                    "durationFormatted",
                    "isFamilySafe",
                    "isUnlisted",
                    "most_replayed",
                    "watchNextVideos"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/video/transcript": {
      "get": {
        "operationId": "youtube_transcript",
        "tags": [
          "YouTube"
        ],
        "summary": "Video transcript",
        "description": "What's said in a video or Short: its captions as timed segments and as one block of text.\n\nUse it to turn a video into text for summaries, search, research or repurposing. It reads the video's captions: the creator's own or YouTube's auto-generated ones (`isGenerated` tells them apart).\n\nPick a language with `language` (e.g. `es`); without it you get English when the video has it, else the video's main language. `availableLanguages` lists every caption track. YouTube's machine translation isn't available, so a language the video has no captions in returns 404.\n\nVideos without captions, and private or removed ones, return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/transcript"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL (watch, youtu.be, /shorts/, /live/ or /embed/ links all work) or its 11-character id, e.g. `https://www.youtube.com/watch?v=dQw4w9WgXcQ`.",
            "schema": {
              "type": "string",
              "description": "The video's URL (watch, youtu.be, /shorts/, /live/ or /embed/ links all work) or its 11-character id, e.g. `https://www.youtube.com/watch?v=dQw4w9WgXcQ`."
            },
            "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Language code, e.g. `en`, `es` or `pt-BR`. `pt` also matches `pt-BR`. Default: English if the video has it, else its main language.",
            "schema": {
              "description": "Language code, e.g. `en`, `es` or `pt-BR`. `pt` also matches `pt-BR`. Default: English if the video has it, else its main language.",
              "type": "string",
              "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "What's said in a video or Short: its captions as timed segments and as one block of text.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "videoId": {
                      "type": "string",
                      "description": "Video id."
                    },
                    "url": {
                      "type": "string",
                      "description": "Link to the video."
                    },
                    "language": {
                      "type": "string",
                      "description": "Language of the transcript, e.g. \"English\"."
                    },
                    "languageCode": {
                      "type": "string",
                      "description": "Its code as YouTube names the track, e.g. `en` or `pt-BR`."
                    },
                    "isGenerated": {
                      "type": "boolean",
                      "description": "Auto-generated by YouTube's speech recognition, rather than captions the creator uploaded."
                    },
                    "transcript": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "text": {
                            "type": "string",
                            "description": "What's said in this segment."
                          },
                          "startMs": {
                            "type": "number",
                            "description": "Segment start, in milliseconds from the start of the video."
                          },
                          "endMs": {
                            "type": "number",
                            "description": "Segment end, in milliseconds. Never past the next segment's start."
                          },
                          "startTimeText": {
                            "type": "string",
                            "description": "Segment start as a timestamp, e.g. \"1:23\"."
                          }
                        },
                        "required": [
                          "text",
                          "startMs",
                          "endMs",
                          "startTimeText"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Timed segments, in order."
                    },
                    "transcript_only_text": {
                      "type": "string",
                      "description": "The whole transcript as one string, without timestamps."
                    },
                    "availableLanguages": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Language code; pass it as `language`."
                          },
                          "name": {
                            "type": "string",
                            "description": "Language name, e.g. \"English\"."
                          },
                          "isGenerated": {
                            "type": "boolean",
                            "description": "Auto-generated rather than uploaded by the creator."
                          }
                        },
                        "required": [
                          "code",
                          "name",
                          "isGenerated"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every caption track the video has."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "videoId",
                    "url",
                    "language",
                    "languageCode",
                    "isGenerated",
                    "transcript",
                    "transcript_only_text",
                    "availableLanguages"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/video/comments": {
      "get": {
        "operationId": "youtube_comments",
        "tags": [
          "YouTube"
        ],
        "summary": "Video comments",
        "description": "A video's comments, top or newest first, with likes, reply counts and who wrote them.\n\nUse it for audience research and sentiment: what viewers say, which comments get the most likes, and what the creator pinned or hearted. About 20 comments per page; the first page also has the exact `commentCount`.\n\n**Pagination.** Pass the response's `continuationToken` back as `continuationToken` (with the same `url`) for the next page; it's null at the end. YouTube stops at about 1,000 top comments, or a few thousand newest ones. If YouTube sends a later page empty, the call fails with `upstream_error` (free) instead of ending the list early. Retry it.\n\n**Replies.** Comments with replies have a `repliesContinuationToken`; pass it to comment replies.\n\nVideos with comments turned off, and unknown videos, return an empty `comments` list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/comments"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL (watch, youtu.be, /shorts/, /live/ or /embed/ links all work) or its 11-character id, e.g. `https://www.youtube.com/watch?v=dQw4w9WgXcQ`.",
            "schema": {
              "type": "string",
              "description": "The video's URL (watch, youtu.be, /shorts/, /live/ or /embed/ links all work) or its 11-character id, e.g. `https://www.youtube.com/watch?v=dQw4w9WgXcQ`."
            },
            "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "`top` (YouTube's ranking) or `newest` first.",
            "schema": {
              "description": "`top` (YouTube's ranking) or `newest` first.",
              "default": "top",
              "type": "string",
              "enum": [
                "top",
                "newest"
              ]
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "The `continuationToken` from the previous response, to get the next page.",
            "schema": {
              "description": "The `continuationToken` from the previous response, to get the next page.",
              "type": "string",
              "minLength": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A video's comments, top or newest first, with likes, reply counts and who wrote them.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Comment id. Replies are `<parent id>.<reply id>`."
                          },
                          "content": {
                            "type": "string",
                            "description": "Comment text."
                          },
                          "publishedTimeText": {
                            "type": "string",
                            "description": "When it was posted, as YouTube shows it, e.g. \"3 days ago\" or \"6 years ago (edited)\"."
                          },
                          "publishedTime": {
                            "description": "Approximate post time, ISO 8601, worked out from publishedTimeText: only as precise as that text (\"6 years ago\" is ±6 months).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "replyLevel": {
                            "type": "number",
                            "description": "0 for a comment, 1 for a reply."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Author's handle, e.g. `@YouTube`."
                              },
                              "channelId": {
                                "description": "Author's channel id, `UC…`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "isVerified": {
                                "type": "boolean",
                                "description": "The author has a verified badge."
                              },
                              "isCreator": {
                                "type": "boolean",
                                "description": "The author is the video's creator."
                              },
                              "avatarUrl": {
                                "description": "Author's avatar URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "channelUrl": {
                                "description": "Author's channel page.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "name",
                              "channelId",
                              "isVerified",
                              "isCreator",
                              "avatarUrl",
                              "channelUrl"
                            ],
                            "additionalProperties": false,
                            "description": "Who wrote it."
                          },
                          "engagement": {
                            "type": "object",
                            "properties": {
                              "likes": {
                                "type": "number",
                                "description": "Likes; YouTube rounds above 1,000 (321K → 321000)."
                              },
                              "replies": {
                                "type": "number",
                                "description": "Number of replies."
                              }
                            },
                            "required": [
                              "likes",
                              "replies"
                            ],
                            "additionalProperties": false,
                            "description": "Likes and replies."
                          },
                          "repliesContinuationToken": {
                            "description": "Pass as `continuationToken` to comment replies to read the replies. null when there are none (and always on replies).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isPinned": {
                            "type": "boolean",
                            "description": "Pinned by the creator."
                          },
                          "isHearted": {
                            "type": "boolean",
                            "description": "Hearted by the creator."
                          }
                        },
                        "required": [
                          "id",
                          "content",
                          "publishedTimeText",
                          "publishedTime",
                          "replyLevel",
                          "author",
                          "engagement",
                          "repliesContinuationToken",
                          "isPinned",
                          "isHearted"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of comments, in the requested order."
                    },
                    "continuationToken": {
                      "description": "Pass as `continuationToken` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "commentCount": {
                      "description": "Exact number of comments on the video (replies included). First page only; null on later pages.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "comments",
                    "continuationToken",
                    "commentCount"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/video/comment/replies": {
      "get": {
        "operationId": "youtube_comment_replies",
        "tags": [
          "YouTube"
        ],
        "summary": "Comment replies",
        "description": "The replies to one YouTube comment.\n\nUse it to read the conversation under a comment. Pass a comment's `repliesContinuationToken` from video comments as `continuationToken`. About 10 replies on the first page and up to 50 on later ones, oldest first.\n\n**Pagination.** Pass the response's `continuationToken` back as `continuationToken` for more replies; it's null at the end.\n\nA token always has replies behind it, so if YouTube sends none, the call fails with `upstream_error` (free). Retry it.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/comment-replies"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "continuationToken",
            "in": "query",
            "required": true,
            "description": "A comment's `repliesContinuationToken` from video comments, or the `continuationToken` from a previous replies page.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "description": "A comment's `repliesContinuationToken` from video comments, or the `continuationToken` from a previous replies page."
            },
            "example": "Eg0SC2RRdzR3OVdnWGNRGAYygwEaUBIaVWd6Z2UzNDBkQmdCNzVoV0JtNTRBYUFCQWciAggAKhhVQ3VBWEZrZ3N3MUw3eGFDZm5kNUpKT3cyC2RRdzR3OVdnWGNRQABICoIBAggBQi9jb21tZW50LXJlcGxpZXMtaXRlbS1VZ3pnZTM0MGRCZ0I3NWhXQm01NEFhQUJBZw%3D%3D"
          }
        ],
        "responses": {
          "200": {
            "description": "The replies to one YouTube comment.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Comment id. Replies are `<parent id>.<reply id>`."
                          },
                          "content": {
                            "type": "string",
                            "description": "Comment text."
                          },
                          "publishedTimeText": {
                            "type": "string",
                            "description": "When it was posted, as YouTube shows it, e.g. \"3 days ago\" or \"6 years ago (edited)\"."
                          },
                          "publishedTime": {
                            "description": "Approximate post time, ISO 8601, worked out from publishedTimeText: only as precise as that text (\"6 years ago\" is ±6 months).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "replyLevel": {
                            "type": "number",
                            "description": "0 for a comment, 1 for a reply."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Author's handle, e.g. `@YouTube`."
                              },
                              "channelId": {
                                "description": "Author's channel id, `UC…`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "isVerified": {
                                "type": "boolean",
                                "description": "The author has a verified badge."
                              },
                              "isCreator": {
                                "type": "boolean",
                                "description": "The author is the video's creator."
                              },
                              "avatarUrl": {
                                "description": "Author's avatar URL.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "channelUrl": {
                                "description": "Author's channel page.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "name",
                              "channelId",
                              "isVerified",
                              "isCreator",
                              "avatarUrl",
                              "channelUrl"
                            ],
                            "additionalProperties": false,
                            "description": "Who wrote it."
                          },
                          "engagement": {
                            "type": "object",
                            "properties": {
                              "likes": {
                                "type": "number",
                                "description": "Likes; YouTube rounds above 1,000 (321K → 321000)."
                              },
                              "replies": {
                                "type": "number",
                                "description": "Number of replies."
                              }
                            },
                            "required": [
                              "likes",
                              "replies"
                            ],
                            "additionalProperties": false,
                            "description": "Likes and replies."
                          },
                          "repliesContinuationToken": {
                            "description": "Pass as `continuationToken` to comment replies to read the replies. null when there are none (and always on replies).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isPinned": {
                            "type": "boolean",
                            "description": "Pinned by the creator."
                          },
                          "isHearted": {
                            "type": "boolean",
                            "description": "Hearted by the creator."
                          }
                        },
                        "required": [
                          "id",
                          "content",
                          "publishedTimeText",
                          "publishedTime",
                          "replyLevel",
                          "author",
                          "engagement",
                          "repliesContinuationToken",
                          "isPinned",
                          "isHearted"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of replies (`replyLevel: 1`)."
                    },
                    "continuationToken": {
                      "description": "Pass as `continuationToken` for more replies. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "comments",
                    "continuationToken"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/channel": {
      "get": {
        "operationId": "youtube_channel",
        "tags": [
          "YouTube"
        ],
        "summary": "Channel details",
        "description": "A channel's subscribers, total views, video count, join date, country, links and description.\n\nUse it to size up a creator: subscribers, lifetime views, number of videos, when they joined, where they're based and the links on their profile. Pass `channelId`, `handle` or a channel `url` (/@handle, /channel/UC…, /c/… and /user/… links all work).\n\nYouTube rounds subscriber counts (519M), so `subscriberCount` is rounded too; `viewCount` and `videoCount` are exact from the about panel. If that panel is unavailable, `videoCount` comes rounded from the channel header, and views, join date, country and links can be missing. `email` is always null: YouTube only shows business emails to signed-in viewers.\n\nUnknown and terminated channels return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/channel"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Channel id, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`. Pass this or `handle`.",
            "schema": {
              "description": "Channel id, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`. Pass this or `handle`.",
              "type": "string"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Channel handle, with or without the @, e.g. `MrBeast`. Pass this or `channelId`.",
            "schema": {
              "description": "Channel handle, with or without the @, e.g. `MrBeast`. Pass this or `channelId`.",
              "type": "string"
            },
            "example": "MrBeast"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Channel URL, e.g. `https://www.youtube.com/@MrBeast`. Instead of `channelId` or `handle`.",
            "schema": {
              "description": "Channel URL, e.g. `https://www.youtube.com/@MrBeast`. Instead of `channelId` or `handle`.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A channel's subscribers, total views, video count, join date, country, links and description.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "channelId": {
                      "type": "string",
                      "description": "Channel id, `UC…`."
                    },
                    "channel": {
                      "type": "string",
                      "description": "Channel page, e.g. `https://www.youtube.com/@MrBeast` (or /channel/UC… without a handle)."
                    },
                    "handle": {
                      "description": "Handle without the @, e.g. `MrBeast`; null if the channel has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "type": "string",
                      "description": "Channel name."
                    },
                    "description": {
                      "type": "string",
                      "description": "The full channel description."
                    },
                    "avatar": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "image": {
                              "type": "object",
                              "properties": {
                                "sources": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "url": {
                                        "type": "string",
                                        "description": "Image URL."
                                      },
                                      "width": {
                                        "type": "number",
                                        "description": "Width in pixels."
                                      },
                                      "height": {
                                        "type": "number",
                                        "description": "Height in pixels."
                                      }
                                    },
                                    "required": [
                                      "url",
                                      "width",
                                      "height"
                                    ],
                                    "additionalProperties": false
                                  },
                                  "description": "The same picture in several sizes, smallest first."
                                }
                              },
                              "required": [
                                "sources"
                              ],
                              "additionalProperties": false,
                              "description": "The picture."
                            }
                          },
                          "required": [
                            "image"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Channel picture in several sizes (YouTube's own shape). `avatarUrl` is the largest."
                    },
                    "avatarUrl": {
                      "description": "Largest channel picture URL (900 px).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "banner": {
                      "description": "Largest banner image URL; null without a banner.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "isVerified": {
                      "type": "boolean",
                      "description": "Has YouTube's verified or official artist badge."
                    },
                    "isFamilySafe": {
                      "type": "boolean",
                      "description": "YouTube marks the channel family safe."
                    },
                    "subscriberCount": {
                      "description": "Subscribers, rounded as YouTube shows them (519M → 519000000). null when hidden.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "subscriberCountText": {
                      "description": "Subscribers as YouTube shows them, e.g. \"519M subscribers\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "videoCount": {
                      "description": "Public videos, Shorts and past streams. Exact from the about panel; rounded as videoCountText if that panel is unavailable.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "videoCountText": {
                      "description": "Video count as YouTube shows it, e.g. \"1,004 videos\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "viewCount": {
                      "description": "Lifetime views across the channel, exact; null if the about panel is unavailable.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "viewCountText": {
                      "description": "Lifetime views as YouTube shows them, e.g. \"141,227,305,543 views\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "joinedDate": {
                      "description": "When the channel was created, `YYYY-MM-DD`.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "joinedDateText": {
                      "description": "Join date as YouTube shows it, e.g. \"Joined Feb 19, 2012\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "country": {
                      "description": "Country the channel lists, e.g. \"United States\"; null if it lists none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "email": {
                      "type": "null",
                      "description": "Always null: YouTube only shows a channel's business email to signed-in viewers."
                    },
                    "links": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "The links on the channel's profile (website, socials, store), in the channel's order."
                    },
                    "twitter": {
                      "description": "The X / Twitter link from `links`, if any.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "instagram": {
                      "description": "The Instagram link from `links`, if any.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "tags": {
                      "description": "The channel's keywords, comma-separated, e.g. \"mrbeast6000, beast, mrbeast\"; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "keywords": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "The same keywords as a list."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "channelId",
                    "channel",
                    "handle",
                    "name",
                    "description",
                    "avatar",
                    "avatarUrl",
                    "banner",
                    "isVerified",
                    "isFamilySafe",
                    "subscriberCount",
                    "subscriberCountText",
                    "videoCount",
                    "videoCountText",
                    "viewCount",
                    "viewCountText",
                    "joinedDate",
                    "joinedDateText",
                    "country",
                    "email",
                    "links",
                    "twitter",
                    "instagram",
                    "tags",
                    "keywords"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/channel-videos": {
      "get": {
        "operationId": "youtube_channel_videos",
        "tags": [
          "YouTube"
        ],
        "summary": "Channel videos",
        "description": "A channel's videos, newest or most popular first, with views, length and upload time.\n\nUse it to see what a creator publishes and what performs: about 30 videos per page from the channel's Videos tab, newest first, or most viewed first with `sort=popular`. Shorts are on their own tab (channel Shorts).\n\nViews are rounded as the channel page shows them (82M views). For exact views, likes, comments and the full description, pass a video's `url` to the video endpoint.\n\n**Pagination.** Pass the response's `continuationToken` back as `continuationToken` for the next page; it's null on the last page.\n\nUnknown channels return 404 `not_found`; a channel without a Videos tab returns an empty list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/channel-videos"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Channel id, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`. Pass this or `handle`.",
            "schema": {
              "description": "Channel id, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`. Pass this or `handle`.",
              "type": "string"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Channel handle, with or without the @, e.g. `MrBeast`. Pass this or `channelId`.",
            "schema": {
              "description": "Channel handle, with or without the @, e.g. `MrBeast`. Pass this or `channelId`.",
              "type": "string"
            },
            "example": "MrBeast"
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Order: `latest` (newest first), `popular` (most viewed) or `oldest`.",
            "schema": {
              "description": "Order: `latest` (newest first), `popular` (most viewed) or `oldest`.",
              "default": "latest",
              "type": "string",
              "enum": [
                "latest",
                "popular",
                "oldest"
              ]
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "The `continuationToken` from the previous response, for the next page. The channel can be left out then.",
            "schema": {
              "description": "The `continuationToken` from the previous response, for the next page. The channel can be left out then.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A channel's videos, newest or most popular first, with views, length and upload time.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "video",
                            "description": "Always `video`."
                          },
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `v9QtM6qnG50`."
                          },
                          "url": {
                            "type": "string",
                            "description": "Watch link. Pass it to the video endpoint for likes, comments, the full description and exact views."
                          },
                          "title": {
                            "type": "string",
                            "description": "Video title. YouTube may translate non-English titles into English; video details has the original."
                          },
                          "thumbnail": {
                            "description": "Largest thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountText": {
                            "description": "Views as YouTube shows them, e.g. \"82M views\", or \"1,204 watching\" while live.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountInt": {
                            "description": "viewCountText as a number, rounded whenever YouTube abbreviates it (82M views → 82000000). Use video details for exact views.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "publishedTimeText": {
                            "description": "When it went up, as YouTube shows it, e.g. \"10 days ago\". null for live and upcoming videos.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "publishedTime": {
                            "description": "publishedTimeText as an estimated ISO 8601 time, counted back from when we fetched the page. Only as precise as the text: \"1 year ago\" means sometime that year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthText": {
                            "description": "Length as shown, e.g. \"19:03\". null for live and upcoming videos.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthSeconds": {
                            "description": "Length in seconds.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "badges": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Labels YouTube shows on the result, e.g. \"4K\", \"CC\", \"New\" or \"LIVE\". Often empty."
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "thumbnail",
                          "viewCountText",
                          "viewCountInt",
                          "publishedTimeText",
                          "publishedTime",
                          "lengthText",
                          "lengthSeconds",
                          "badges"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of videos, in `sort` order."
                    },
                    "continuationToken": {
                      "description": "Pass as `continuationToken` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "videos",
                    "continuationToken"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/channel/shorts": {
      "get": {
        "operationId": "youtube_channel_shorts",
        "tags": [
          "YouTube"
        ],
        "summary": "Channel Shorts",
        "description": "A channel's Shorts, newest or most popular first, with titles and view counts.\n\nUse it to track a creator's short-form output: about 48 Shorts per page from the channel's Shorts tab, newest first, or most viewed first with `sort=popular`.\n\nThe Shorts tab only shows title, thumbnail and views. For likes, comments, upload date and length, pass a Short's `url` to the video endpoint; we don't fetch those for every Short, so a page stays one fast request.\n\n**Pagination.** Pass the response's `continuationToken` back as `continuationToken` for the next page; it's null on the last page.\n\nUnknown channels return 404 `not_found`; a channel without Shorts returns an empty list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/channel-shorts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Channel id, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`. Pass this or `handle`.",
            "schema": {
              "description": "Channel id, e.g. `UCX6OQ3DkcsbYNE6H8uQQuVA`. Pass this or `handle`.",
              "type": "string"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Channel handle, with or without the @, e.g. `MrBeast`. Pass this or `channelId`.",
            "schema": {
              "description": "Channel handle, with or without the @, e.g. `MrBeast`. Pass this or `channelId`.",
              "type": "string"
            },
            "example": "MrBeast"
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Order: `newest` first, `popular` (most viewed) or `oldest`.",
            "schema": {
              "description": "Order: `newest` first, `popular` (most viewed) or `oldest`.",
              "default": "newest",
              "type": "string",
              "enum": [
                "newest",
                "popular",
                "oldest"
              ]
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "The `continuationToken` from the previous response, for the next page. The channel can be left out then.",
            "schema": {
              "description": "The `continuationToken` from the previous response, for the next page. The channel can be left out then.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A channel's Shorts, newest or most popular first, with titles and view counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "shorts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "short",
                            "description": "Always `short`."
                          },
                          "id": {
                            "type": "string",
                            "description": "The Short's video id."
                          },
                          "url": {
                            "type": "string",
                            "description": "`https://www.youtube.com/shorts/<id>`. Pass it to the video endpoint for likes, comments, date and length."
                          },
                          "title": {
                            "type": "string",
                            "description": "The Short's title. YouTube may translate non-English titles into English; video details has the original."
                          },
                          "thumbnail": {
                            "description": "Largest (vertical) thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountText": {
                            "description": "Views as YouTube shows them, e.g. \"22M views\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountInt": {
                            "description": "viewCountText as a number, rounded as shown (22M views → 22000000).",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "thumbnail",
                          "viewCountText",
                          "viewCountInt"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of Shorts, in `sort` order."
                    },
                    "continuationToken": {
                      "description": "Pass as `continuationToken` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "shorts",
                    "continuationToken"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/youtube/search": {
      "get": {
        "operationId": "youtube_search",
        "tags": [
          "YouTube"
        ],
        "summary": "Search YouTube",
        "description": "Search YouTube by keyword for videos, Shorts, channels and playlists, with date, length and type filters.\n\nUse it for trend, topic and competitor research: what YouTube's search page shows for a keyword, split into `videos`, `shorts`, `channels`, `playlists` and `lives` (streaming now). About 20 results per page. Narrow it with `type`, `uploadDate`, `duration` (videos only) and `sortBy=popular`.\n\nVideo results carry views as YouTube shows them, a description snippet and the channel. Counts may be rounded; video details returns exact views. Shorts carry title and views only; pass a Short's `url` to the video endpoint for the rest.\n\n**Pagination.** Pass the response's `continuationToken` back as `continuationToken` (with the same query) for the next page; it's null on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/youtube/search"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Keywords, e.g. `running shoes`. YouTube's operators work, e.g. `intitle:\"air max\"`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "description": "Keywords, e.g. `running shoes`. YouTube's operators work, e.g. `intitle:\"air max\"`."
            },
            "example": "running shoes"
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "What to search for. `all` mixes them like youtube.com.",
            "schema": {
              "description": "What to search for. `all` mixes them like youtube.com.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "videos",
                "shorts",
                "channels",
                "playlists"
              ]
            }
          },
          {
            "name": "uploadDate",
            "in": "query",
            "required": false,
            "description": "Only results uploaded in this window.",
            "schema": {
              "description": "Only results uploaded in this window.",
              "default": "any",
              "type": "string",
              "enum": [
                "any",
                "today",
                "this_week",
                "this_month",
                "this_year"
              ]
            }
          },
          {
            "name": "duration",
            "in": "query",
            "required": false,
            "description": "Video length. Doesn't apply to Shorts.",
            "schema": {
              "description": "Video length. Doesn't apply to Shorts.",
              "default": "any",
              "type": "string",
              "enum": [
                "any",
                "under_3_min",
                "between_3_and_20_min",
                "over_20_min"
              ]
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "required": false,
            "description": "`relevance` (YouTube's default) or `popular` (most viewed first).",
            "schema": {
              "description": "`relevance` (YouTube's default) or `popular` (most viewed first).",
              "default": "relevance",
              "type": "string",
              "enum": [
                "relevance",
                "popular"
              ]
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "The `continuationToken` from the previous response, for the next page.",
            "schema": {
              "description": "The `continuationToken` from the previous response, for the next page.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search YouTube by keyword for videos, Shorts, channels and playlists, with date, length and type filters.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "video",
                            "description": "Always `video`."
                          },
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `v9QtM6qnG50`."
                          },
                          "url": {
                            "type": "string",
                            "description": "Watch link. Pass it to the video endpoint for likes, comments, the full description and exact views."
                          },
                          "title": {
                            "type": "string",
                            "description": "Video title. YouTube may translate non-English titles into English; video details has the original."
                          },
                          "thumbnail": {
                            "description": "Largest thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountText": {
                            "description": "Views as YouTube shows them, e.g. \"82M views\", or \"1,204 watching\" while live.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountInt": {
                            "description": "viewCountText as a number, rounded whenever YouTube abbreviates it (82M views → 82000000). Use video details for exact views.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "publishedTimeText": {
                            "description": "When it went up, as YouTube shows it, e.g. \"10 days ago\". null for live and upcoming videos.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "publishedTime": {
                            "description": "publishedTimeText as an estimated ISO 8601 time, counted back from when we fetched the page. Only as precise as the text: \"1 year ago\" means sometime that year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthText": {
                            "description": "Length as shown, e.g. \"19:03\". null for live and upcoming videos.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthSeconds": {
                            "description": "Length in seconds.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "badges": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Labels YouTube shows on the result, e.g. \"4K\", \"CC\", \"New\" or \"LIVE\". Often empty."
                          },
                          "description": {
                            "description": "The description snippet shown under the result, usually its first line or two.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "channel": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "description": "Channel id, `UC…`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "title": {
                                    "description": "Channel name.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "handle": {
                                    "description": "Handle without the @, e.g. `BenParkes`; null if YouTube shows none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "url": {
                                    "description": "Channel page, e.g. `https://www.youtube.com/@BenParkes`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "thumbnail": {
                                    "description": "Channel picture URL; null when the result doesn't show one.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "handle",
                                  "url",
                                  "thumbnail"
                                ],
                                "additionalProperties": false,
                                "description": "The channel behind it."
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "thumbnail",
                          "viewCountText",
                          "viewCountInt",
                          "publishedTimeText",
                          "publishedTime",
                          "lengthText",
                          "lengthSeconds",
                          "badges",
                          "description",
                          "channel"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Videos, in result order."
                    },
                    "shorts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "short",
                            "description": "Always `short`."
                          },
                          "id": {
                            "type": "string",
                            "description": "The Short's video id."
                          },
                          "url": {
                            "type": "string",
                            "description": "`https://www.youtube.com/shorts/<id>`. Pass it to the video endpoint for likes, comments, date and length."
                          },
                          "title": {
                            "type": "string",
                            "description": "The Short's title. YouTube may translate non-English titles into English; video details has the original."
                          },
                          "thumbnail": {
                            "description": "Largest (vertical) thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountText": {
                            "description": "Views as YouTube shows them, e.g. \"22M views\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountInt": {
                            "description": "viewCountText as a number, rounded as shown (22M views → 22000000).",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "thumbnail",
                          "viewCountText",
                          "viewCountInt"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Shorts, in result order."
                    },
                    "channels": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "channel",
                            "description": "Always `channel`."
                          },
                          "id": {
                            "type": "string",
                            "description": "Channel id, `UC…`. Pass it to channel details for the full stats."
                          },
                          "url": {
                            "type": "string",
                            "description": "Channel page."
                          },
                          "title": {
                            "type": "string",
                            "description": "Channel name."
                          },
                          "handle": {
                            "description": "Handle without the @; null if YouTube shows none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnail": {
                            "description": "Channel picture URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "description": {
                            "description": "The description snippet shown in the result.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "subscriberCountText": {
                            "description": "Subscribers as YouTube shows them, e.g. \"128K subscribers\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "subscriberCount": {
                            "description": "subscriberCountText as a number, rounded as shown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "isVerified": {
                            "type": "boolean",
                            "description": "Has YouTube's verified or official artist badge."
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "handle",
                          "thumbnail",
                          "description",
                          "subscriberCountText",
                          "subscriberCount",
                          "isVerified"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Channels, in result order."
                    },
                    "playlists": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "playlist",
                            "description": "Always `playlist`."
                          },
                          "id": {
                            "type": "string",
                            "description": "Playlist id, e.g. `PLB50X6wE7gSWNQJElg3NX4AH42QoouHOk` (mixes start with `RD`)."
                          },
                          "url": {
                            "type": "string",
                            "description": "Playlist page, `https://www.youtube.com/playlist?list=<id>`."
                          },
                          "title": {
                            "type": "string",
                            "description": "Playlist title."
                          },
                          "thumbnail": {
                            "description": "Cover thumbnail URL (its first video).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "videoCountText": {
                            "description": "Size as YouTube shows it, e.g. \"30 videos\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "videoCount": {
                            "description": "videoCountText as a number.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "channel": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "description": "Channel id, `UC…`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "title": {
                                    "description": "Channel name.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "handle": {
                                    "description": "Handle without the @, e.g. `BenParkes`; null if YouTube shows none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "url": {
                                    "description": "Channel page, e.g. `https://www.youtube.com/@BenParkes`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "thumbnail": {
                                    "description": "Channel picture URL; null when the result doesn't show one.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "handle",
                                  "url",
                                  "thumbnail"
                                ],
                                "additionalProperties": false,
                                "description": "The channel behind it."
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "thumbnail",
                          "videoCountText",
                          "videoCount",
                          "channel"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Playlists and mixes, in result order."
                    },
                    "lives": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "video",
                            "description": "Always `video`."
                          },
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `v9QtM6qnG50`."
                          },
                          "url": {
                            "type": "string",
                            "description": "Watch link. Pass it to the video endpoint for likes, comments, the full description and exact views."
                          },
                          "title": {
                            "type": "string",
                            "description": "Video title. YouTube may translate non-English titles into English; video details has the original."
                          },
                          "thumbnail": {
                            "description": "Largest thumbnail URL.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountText": {
                            "description": "Views as YouTube shows them, e.g. \"82M views\", or \"1,204 watching\" while live.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "viewCountInt": {
                            "description": "viewCountText as a number, rounded whenever YouTube abbreviates it (82M views → 82000000). Use video details for exact views.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "publishedTimeText": {
                            "description": "When it went up, as YouTube shows it, e.g. \"10 days ago\". null for live and upcoming videos.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "publishedTime": {
                            "description": "publishedTimeText as an estimated ISO 8601 time, counted back from when we fetched the page. Only as precise as the text: \"1 year ago\" means sometime that year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthText": {
                            "description": "Length as shown, e.g. \"19:03\". null for live and upcoming videos.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lengthSeconds": {
                            "description": "Length in seconds.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "badges": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Labels YouTube shows on the result, e.g. \"4K\", \"CC\", \"New\" or \"LIVE\". Often empty."
                          },
                          "description": {
                            "description": "The description snippet shown under the result, usually its first line or two.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "channel": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "description": "Channel id, `UC…`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "title": {
                                    "description": "Channel name.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "handle": {
                                    "description": "Handle without the @, e.g. `BenParkes`; null if YouTube shows none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "url": {
                                    "description": "Channel page, e.g. `https://www.youtube.com/@BenParkes`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "thumbnail": {
                                    "description": "Channel picture URL; null when the result doesn't show one.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "handle",
                                  "url",
                                  "thumbnail"
                                ],
                                "additionalProperties": false,
                                "description": "The channel behind it."
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "id",
                          "url",
                          "title",
                          "thumbnail",
                          "viewCountText",
                          "viewCountInt",
                          "publishedTimeText",
                          "publishedTime",
                          "lengthText",
                          "lengthSeconds",
                          "badges",
                          "description",
                          "channel"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Streams that are live right now."
                    },
                    "continuationToken": {
                      "description": "Pass as `continuationToken` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "videos",
                    "shorts",
                    "channels",
                    "playlists",
                    "lives",
                    "continuationToken"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/profile": {
      "get": {
        "operationId": "tiktok_profile",
        "tags": [
          "TikTok"
        ],
        "summary": "Profile",
        "description": "A creator's bio, avatar, verification and exact follower, like and video counts.\n\nUse it to size up a creator or brand account: followers, total likes and video count as exact numbers, plus bio, link and category. `user.secUid` is TikTok's stable id. `user.roomId` points to a live stream, but it can be one that already ended; check live status to be sure.\n\nUnknown, banned and deleted accounts return 404 `not_found`. Private accounts return their profile with `privateAccount: true`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
            "schema": {
              "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
              "type": "string"
            },
            "example": "nike"
          }
        ],
        "responses": {
          "200": {
            "description": "A creator's bio, avatar, verification and exact follower, like and video counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Numeric user id."
                        },
                        "uniqueId": {
                          "type": "string",
                          "description": "Username (handle), without @."
                        },
                        "nickname": {
                          "type": "string",
                          "description": "Display name."
                        },
                        "signature": {
                          "type": "string",
                          "description": "Bio text."
                        },
                        "secUid": {
                          "type": "string",
                          "description": "TikTok's long, stable user id; other tools ask for it."
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has the verified badge."
                        },
                        "privateAccount": {
                          "type": "boolean",
                          "description": "The account is private: videos and follower lists are hidden."
                        },
                        "createTime": {
                          "type": "number",
                          "description": "Account created, Unix seconds."
                        },
                        "avatarLarger": {
                          "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "avatarMedium": {
                          "description": "Medium avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "avatarThumb": {
                          "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "bioLink": {
                          "description": "The link in the bio; null if none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "language": {
                          "description": "Account language, e.g. `en`; null if unknown.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "category": {
                          "description": "Business category, e.g. \"Sports, Fitness & Outdoors\"; null for personal accounts.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "commerceUser": {
                          "type": "boolean",
                          "description": "A business account."
                        },
                        "ttSeller": {
                          "type": "boolean",
                          "description": "Sells on TikTok Shop."
                        },
                        "isOrganization": {
                          "type": "boolean",
                          "description": "Registered as an organization."
                        },
                        "roomId": {
                          "description": "Live room id TikTok reports. It can belong to a stream that already ended, so check live status to be sure; null when none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "uniqueId",
                        "nickname",
                        "signature",
                        "secUid",
                        "verified",
                        "privateAccount",
                        "createTime",
                        "avatarLarger",
                        "avatarMedium",
                        "avatarThumb",
                        "bioLink",
                        "language",
                        "category",
                        "commerceUser",
                        "ttSeller",
                        "isOrganization",
                        "roomId"
                      ],
                      "additionalProperties": false,
                      "description": "The account."
                    },
                    "stats": {
                      "type": "object",
                      "properties": {
                        "followerCount": {
                          "type": "number",
                          "description": "Followers, exact."
                        },
                        "followingCount": {
                          "type": "number",
                          "description": "Accounts they follow."
                        },
                        "heartCount": {
                          "type": "number",
                          "description": "Total likes received across all videos."
                        },
                        "videoCount": {
                          "type": "number",
                          "description": "Public videos."
                        },
                        "diggCount": {
                          "type": "number",
                          "description": "Videos they liked (0 when hidden)."
                        },
                        "friendCount": {
                          "type": "number",
                          "description": "Mutual follows."
                        }
                      },
                      "required": [
                        "followerCount",
                        "followingCount",
                        "heartCount",
                        "videoCount",
                        "diggCount",
                        "friendCount"
                      ],
                      "additionalProperties": false,
                      "description": "Counts when fetched."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "user",
                    "stats"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v2/tiktok/video": {
      "get": {
        "operationId": "tiktok_video",
        "tags": [
          "TikTok"
        ],
        "summary": "Video details",
        "description": "One video or photo post: caption, stats, author, sound, hashtags and a playable MP4 URL.\n\nUse it to track a post's views, likes, comments, shares and saves, or to get its media. `video.playUrl` plays without cookies until `video.expires_at` (about two days); fetch the post again for a fresh one. Photo posts have their slides in `images`.\n\n`playUrl` can refuse visitors outside the US. Pass `cdn_url=true` to also get `cdnUrl`, the file on TikTok's CDN it redirects to, which plays from anywhere for a few hours (same credit).\n\nPass `get_transcript=true` to also get the captions as WEBVTT in `transcript` (same credit).\n\nDeleted, private and region-locked posts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/video"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
            "schema": {
              "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
              "type": "string"
            },
            "example": "https://www.tiktok.com/@hubspot/video/7671325437229845774"
          },
          {
            "name": "get_transcript",
            "in": "query",
            "required": false,
            "description": "`true` adds the captions as WEBVTT in `transcript` (null if the video has none).",
            "schema": {
              "description": "`true` adds the captions as WEBVTT in `transcript` (null if the video has none).",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "cdn_url",
            "in": "query",
            "required": false,
            "description": "`true` adds `cdnUrl`, the MP4 on TikTok's CDN that `video.playUrl` redirects to.",
            "schema": {
              "description": "`true` adds `cdnUrl`, the MP4 on TikTok's CDN that `video.playUrl` redirects to.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One video or photo post: caption, stats, author, sound, hashtags and a playable MP4 URL.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Video id, e.g. `7671325437229845774`."
                    },
                    "url": {
                      "type": "string",
                      "description": "The post on tiktok.com."
                    },
                    "desc": {
                      "type": "string",
                      "description": "Caption, hashtags included."
                    },
                    "title": {
                      "description": "A photo post's title, shown above the caption, e.g. `tom & jerry art`; null for videos and untitled posts.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "createTime": {
                      "type": "number",
                      "description": "Posted at, Unix seconds."
                    },
                    "textLanguage": {
                      "description": "Caption language as TikTok detects it, e.g. `en`; `un` = undetermined; null if unknown.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "locationCreated": {
                      "description": "Country the post was made in, as a 2-letter code. Only video details have it; null in lists and when unknown.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "isAd": {
                      "type": "boolean",
                      "description": "A paid ad (Spark Ad or promoted post)."
                    },
                    "author": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Numeric user id."
                        },
                        "uniqueId": {
                          "type": "string",
                          "description": "Username (handle), without @."
                        },
                        "nickname": {
                          "type": "string",
                          "description": "Display name."
                        },
                        "secUid": {
                          "type": "string",
                          "description": "TikTok's long, stable user id; other tools ask for it."
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has the verified badge."
                        },
                        "privateAccount": {
                          "type": "boolean",
                          "description": "The account is private."
                        },
                        "avatarThumb": {
                          "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "avatarLarger": {
                          "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "uniqueId",
                        "nickname",
                        "secUid",
                        "verified",
                        "privateAccount",
                        "avatarThumb",
                        "avatarLarger"
                      ],
                      "additionalProperties": false,
                      "description": "Who posted it."
                    },
                    "stats": {
                      "type": "object",
                      "properties": {
                        "playCount": {
                          "type": "number",
                          "description": "Views."
                        },
                        "diggCount": {
                          "type": "number",
                          "description": "Likes."
                        },
                        "commentCount": {
                          "type": "number",
                          "description": "Comments."
                        },
                        "shareCount": {
                          "type": "number",
                          "description": "Shares."
                        },
                        "collectCount": {
                          "description": "Saves (favorites); null where TikTok doesn't show it.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "repostCount": {
                          "description": "Reposts; null where TikTok doesn't show it.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "playCount",
                        "diggCount",
                        "commentCount",
                        "shareCount",
                        "collectCount",
                        "repostCount"
                      ],
                      "additionalProperties": false,
                      "description": "Engagement when fetched, as tiktok.com gives it: exact for smaller counts, rounded for large ones (e.g. `2500000` views)."
                    },
                    "video": {
                      "type": "object",
                      "properties": {
                        "duration": {
                          "type": "number",
                          "description": "Length in seconds; 0 for photo posts."
                        },
                        "width": {
                          "type": "number",
                          "description": "Width in pixels; 0 for photo posts."
                        },
                        "height": {
                          "type": "number",
                          "description": "Height in pixels; 0 for photo posts."
                        },
                        "definition": {
                          "description": "Quality of the default rendition, e.g. `720p`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "cover": {
                          "description": "Cover image URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "dynamicCover": {
                          "description": "Animated cover URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "playUrl": {
                          "description": "MP4 URL that plays without cookies (h264, best quality). It redirects to TikTok's CDN and expires at `expires_at`; null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "expires_at": {
                          "description": "When `playUrl` stops working, Unix seconds; null if unknown.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "duration",
                        "width",
                        "height",
                        "definition",
                        "cover",
                        "dynamicCover",
                        "playUrl",
                        "expires_at"
                      ],
                      "additionalProperties": false,
                      "description": "The video file. For photo posts see `images`."
                    },
                    "music": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Sound id; pass it to song endpoints."
                            },
                            "title": {
                              "type": "string",
                              "description": "Sound title, e.g. `original sound`."
                            },
                            "authorName": {
                              "description": "Artist, or the creator for original sounds.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "original": {
                              "type": "boolean",
                              "description": "An original sound made with this post rather than a track."
                            },
                            "duration": {
                              "description": "Length in seconds.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "playUrl": {
                              "description": "Audio URL (expires after a few hours); null if TikTok has none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "cover": {
                              "description": "Sound cover image URL; null if TikTok has none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "title",
                            "authorName",
                            "original",
                            "duration",
                            "playUrl",
                            "cover"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The sound; null if the post has none."
                    },
                    "hashtags": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Hashtag without #."
                      },
                      "description": "Hashtags in the caption, without #."
                    },
                    "mentions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Username without @."
                      },
                      "description": "Usernames @mentioned in the caption."
                    },
                    "images": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string",
                            "description": "Image URL (expires after a few days)."
                          },
                          "width": {
                            "type": "number",
                            "description": "Width in pixels."
                          },
                          "height": {
                            "type": "number",
                            "description": "Height in pixels."
                          }
                        },
                        "required": [
                          "url",
                          "width",
                          "height"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The slides of a photo post, in order. Empty for videos."
                    },
                    "transcript": {
                      "description": "With `get_transcript=true`: the captions as WEBVTT in the video's original language; null if it has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "cdnUrl": {
                      "description": "With `cdn_url=true`: the MP4 on TikTok's CDN, without cookies and from anywhere, for a few hours; null for photo posts or when TikTok doesn't redirect.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "desc",
                    "title",
                    "createTime",
                    "textLanguage",
                    "locationCreated",
                    "isAd",
                    "author",
                    "stats",
                    "video",
                    "music",
                    "hashtags",
                    "mentions",
                    "images"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/video/transcript": {
      "get": {
        "operationId": "tiktok_transcript",
        "tags": [
          "TikTok"
        ],
        "summary": "Video transcript",
        "description": "What's said in a video, from TikTok's captions: WEBVTT with timestamps plus plain text.\n\nUse it to turn a TikTok into text: repurpose a script, search what creators say, or feed it to an LLM. `transcript` is WEBVTT with timestamps (the same format other TikTok APIs return); `text` is the same words as plain text.\n\nTranscripts come from TikTok's own captions: auto-generated speech captions (`source: asr`), the creator's own captions, or TikTok's translations. Most spoken videos have them. A video without captions (music only, or captions off) returns `transcript: null` with `languages: []`.\n\n**No captions?** Pass `use_ai_as_fallback=true` and we transcribe the audio ourselves (`source: ai`) for videos up to 2 minutes. That costs 2 credits in total, and only when it runs; with captions it's still 1. If it hears no speech (music only), you get 404 `transcript_unavailable` at the base price, and that answer is cached.\n\nBy default you get the original language. Pass `language` (e.g. `es`) to pick one of `languages`.\n\nDeleted, private and region-locked videos return 404 `not_found`.\n\nCost: 1 credit; 2 if speech-to-text runs.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/transcript"
        },
        "x-credits": 1,
        "x-extra-credits": {
          "asr": 1
        },
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
            "schema": {
              "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
              "type": "string"
            },
            "example": "https://www.tiktok.com/@hubspot/video/7671325437229845774"
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "2-letter language code, e.g. `en` or `es`. Default: the video's original language.",
            "schema": {
              "description": "2-letter language code, e.g. `en` or `es`. Default: the video's original language.",
              "type": "string",
              "pattern": "^[a-z]{2,3}(-[a-z]{2})?$"
            }
          },
          {
            "name": "use_ai_as_fallback",
            "in": "query",
            "required": false,
            "description": "`true`: if the video has no captions, transcribe its audio with speech-to-text (videos up to 2 minutes; 2 credits in total, only when it runs).",
            "schema": {
              "description": "`true`: if the video has no captions, transcribe its audio with speech-to-text (videos up to 2 minutes; 2 credits in total, only when it runs).",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "max_credits",
            "in": "query",
            "required": false,
            "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
            "schema": {
              "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          }
        ],
        "responses": {
          "200": {
            "description": "What's said in a video, from TikTok's captions: WEBVTT with timestamps plus plain text.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Video id."
                    },
                    "url": {
                      "type": "string",
                      "description": "The video on tiktok.com."
                    },
                    "transcript": {
                      "description": "The captions as WEBVTT, with timestamps. null if the video has none in that language.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "text": {
                      "description": "The same captions as plain text, one cue per line. null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "language": {
                      "description": "Language of `transcript`, e.g. `en`. null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "source": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "asr",
                            "creator",
                            "translation",
                            "ai"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "`asr`: TikTok's auto-generated speech captions. `creator`: captions the creator wrote. `translation`: TikTok's machine translation. `ai`: our speech-to-text (`use_ai_as_fallback`). null if none."
                    },
                    "languages": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "language": {
                            "type": "string",
                            "description": "Language code, usually 2 letters, e.g. `en`."
                          },
                          "source": {
                            "type": "string",
                            "enum": [
                              "asr",
                              "creator",
                              "translation"
                            ],
                            "description": "Where these captions come from (see `source`)."
                          }
                        },
                        "required": [
                          "language",
                          "source"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every caption language TikTok has for the video. Empty when it has none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "transcript",
                    "text",
                    "language",
                    "source",
                    "languages"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "transcript_unavailable: The video has no captions, and speech-to-text heard no speech in it. You pay the base credit, never the speech-to-text extra. The answer is cached.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v3/tiktok/profile/videos": {
      "get": {
        "operationId": "tiktok_profile_videos",
        "tags": [
          "TikTok"
        ],
        "summary": "Profile videos",
        "description": "A creator's videos and photo posts, newest first, up to 15 per page.\n\nUse it to audit a creator's recent content: every post with views, likes, comments, shares, saves, caption and media. Posts come newest first, up to 15 per page. Pinned posts appear in date order, like every other post. The creator's follower count comes along (rounded, as TikTok shows it there), so engagement per follower takes one call.\n\n**Pagination.** Pass the response's `max_cursor` back as `max_cursor` (with the same `handle`) for older posts. `has_more` is false at the end. A creator who hasn't posted for weeks can give a page with no posts but `has_more: true`; keep paging.\n\nUnknown, banned and deleted accounts return 404 `not_found`. Private accounts return an empty `videos` list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/profile-videos"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
            "schema": {
              "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
              "type": "string"
            },
            "example": "hubspot"
          },
          {
            "name": "max_cursor",
            "in": "query",
            "required": false,
            "description": "The `max_cursor` from the previous response, to get older posts.",
            "schema": {
              "description": "The `max_cursor` from the previous response, to get older posts.",
              "type": "string",
              "pattern": "^\\d{1,20}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A creator's videos and photo posts, newest first, up to 15 per page.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `7671325437229845774`."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on tiktok.com."
                          },
                          "desc": {
                            "type": "string",
                            "description": "Caption, hashtags included."
                          },
                          "title": {
                            "description": "A photo post's title, shown above the caption, e.g. `tom & jerry art`; null for videos and untitled posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "createTime": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "textLanguage": {
                            "description": "Caption language as TikTok detects it, e.g. `en`; `un` = undetermined; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "locationCreated": {
                            "description": "Country the post was made in, as a 2-letter code. Only video details have it; null in lists and when unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isAd": {
                            "type": "boolean",
                            "description": "A paid ad (Spark Ad or promoted post)."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "uniqueId": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "secUid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id; other tools ask for it."
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the verified badge."
                              },
                              "privateAccount": {
                                "type": "boolean",
                                "description": "The account is private."
                              },
                              "avatarThumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatarLarger": {
                                "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "uniqueId",
                              "nickname",
                              "secUid",
                              "verified",
                              "privateAccount",
                              "avatarThumb",
                              "avatarLarger"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "stats": {
                            "type": "object",
                            "properties": {
                              "playCount": {
                                "type": "number",
                                "description": "Views."
                              },
                              "diggCount": {
                                "type": "number",
                                "description": "Likes."
                              },
                              "commentCount": {
                                "type": "number",
                                "description": "Comments."
                              },
                              "shareCount": {
                                "type": "number",
                                "description": "Shares."
                              },
                              "collectCount": {
                                "description": "Saves (favorites); null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "repostCount": {
                                "description": "Reposts; null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "playCount",
                              "diggCount",
                              "commentCount",
                              "shareCount",
                              "collectCount",
                              "repostCount"
                            ],
                            "additionalProperties": false,
                            "description": "Engagement when fetched, as tiktok.com gives it: exact for smaller counts, rounded for large ones (e.g. `2500000` views)."
                          },
                          "video": {
                            "type": "object",
                            "properties": {
                              "duration": {
                                "type": "number",
                                "description": "Length in seconds; 0 for photo posts."
                              },
                              "width": {
                                "type": "number",
                                "description": "Width in pixels; 0 for photo posts."
                              },
                              "height": {
                                "type": "number",
                                "description": "Height in pixels; 0 for photo posts."
                              },
                              "definition": {
                                "description": "Quality of the default rendition, e.g. `720p`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cover": {
                                "description": "Cover image URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "dynamicCover": {
                                "description": "Animated cover URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "playUrl": {
                                "description": "MP4 URL that plays without cookies (h264, best quality). It redirects to TikTok's CDN and expires at `expires_at`; null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "expires_at": {
                                "description": "When `playUrl` stops working, Unix seconds; null if unknown.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "duration",
                              "width",
                              "height",
                              "definition",
                              "cover",
                              "dynamicCover",
                              "playUrl",
                              "expires_at"
                            ],
                            "additionalProperties": false,
                            "description": "The video file. For photo posts see `images`."
                          },
                          "music": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Sound id; pass it to song endpoints."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Sound title, e.g. `original sound`."
                                  },
                                  "authorName": {
                                    "description": "Artist, or the creator for original sounds.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "original": {
                                    "type": "boolean",
                                    "description": "An original sound made with this post rather than a track."
                                  },
                                  "duration": {
                                    "description": "Length in seconds.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "playUrl": {
                                    "description": "Audio URL (expires after a few hours); null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "cover": {
                                    "description": "Sound cover image URL; null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "authorName",
                                  "original",
                                  "duration",
                                  "playUrl",
                                  "cover"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The sound; null if the post has none."
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Hashtag without #."
                            },
                            "description": "Hashtags in the caption, without #."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Username without @."
                            },
                            "description": "Usernames @mentioned in the caption."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Image URL (expires after a few days)."
                                },
                                "width": {
                                  "type": "number",
                                  "description": "Width in pixels."
                                },
                                "height": {
                                  "type": "number",
                                  "description": "Height in pixels."
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The slides of a photo post, in order. Empty for videos."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "desc",
                          "title",
                          "createTime",
                          "textLanguage",
                          "locationCreated",
                          "isAd",
                          "author",
                          "stats",
                          "video",
                          "music",
                          "hashtags",
                          "mentions",
                          "images"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Posts, newest first."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "There are older posts."
                    },
                    "max_cursor": {
                      "description": "Pass as `max_cursor` for older posts. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "followerCount": {
                      "description": "The creator's followers, rounded as TikTok shows them beside their posts (15.5M → 15500000); null on an empty page. The profile endpoint has the exact count.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "videos",
                    "has_more",
                    "max_cursor",
                    "followerCount"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/video/comments": {
      "get": {
        "operationId": "tiktok_comments",
        "tags": [
          "TikTok"
        ],
        "summary": "Video comments",
        "description": "A video's top-level comments, most relevant first, with like and reply counts.\n\nUse it to read what viewers say: objections, questions, praise and the words your audience uses. Each comment has its likes, reply count and author; pass a comment's `cid` as `comment_id` to comment replies for its thread.\n\n**Pagination.** Up to 50 comments per page (TikTok hides some, so pages often have fewer). Pass the response's `cursor` back as `cursor` (with the same `url`) for more; it's null at the end.\n\nDeleted or private videos return 404 `not_found`; videos with comments turned off return an empty list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/comments"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
            "schema": {
              "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
              "type": "string"
            },
            "example": "https://www.tiktok.com/@scout2015/video/6718335390845095173"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string",
              "pattern": "^\\d{1,20}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A video's top-level comments, most relevant first, with like and reply counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "cid": {
                            "type": "string",
                            "description": "Comment id; pass it as `comment_id` to comment replies."
                          },
                          "text": {
                            "type": "string",
                            "description": "Comment text; empty when the comment is only a photo (see `image_list`) or a sticker."
                          },
                          "create_time": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "digg_count": {
                            "type": "number",
                            "description": "Likes."
                          },
                          "reply_comment_total": {
                            "type": "number",
                            "description": "Replies to this comment. Always 0 on replies."
                          },
                          "comment_language": {
                            "description": "Language as TikTok detects it, e.g. `en`; `un` = undetermined.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author_pin": {
                            "type": "boolean",
                            "description": "Pinned by the video's creator."
                          },
                          "is_author_digged": {
                            "type": "boolean",
                            "description": "Liked by the video's creator."
                          },
                          "reply_id": {
                            "type": "string",
                            "description": "On replies: the comment it belongs to. `0` on top-level comments."
                          },
                          "reply_to_reply_id": {
                            "type": "string",
                            "description": "On replies: the reply it answers, if any. `0` otherwise."
                          },
                          "aweme_id": {
                            "type": "string",
                            "description": "The video's id."
                          },
                          "image_list": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "Full-size image URL (expires after a few weeks)."
                                    },
                                    "width": {
                                      "description": "Width in pixels; null if TikTok doesn't say.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "height": {
                                      "description": "Height in pixels; null if TikTok doesn't say.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "width",
                                    "height"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Photos attached to the comment; null if it has none."
                          },
                          "user": {
                            "type": "object",
                            "properties": {
                              "uid": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "unique_id": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "sec_uid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id."
                              },
                              "avatar_thumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "uid",
                              "unique_id",
                              "nickname",
                              "sec_uid",
                              "avatar_thumb"
                            ],
                            "additionalProperties": false,
                            "description": "Who wrote it."
                          }
                        },
                        "required": [
                          "cid",
                          "text",
                          "create_time",
                          "digg_count",
                          "reply_comment_total",
                          "comment_language",
                          "author_pin",
                          "is_author_digged",
                          "reply_id",
                          "reply_to_reply_id",
                          "aweme_id",
                          "image_list",
                          "user"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Comments, in TikTok's order."
                    },
                    "total": {
                      "type": "number",
                      "description": "Comments TikTok counts in this thread (may include some it no longer shows)."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "More comments after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "description": "The video's link: `https://www.tiktok.com/@<creator>/video/<id>` when the link you passed (or where a share link leads) names the creator, else `https://m.tiktok.com/v/<id>.html`."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "comments",
                    "total",
                    "has_more",
                    "cursor",
                    "url"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/video/comment/replies": {
      "get": {
        "operationId": "tiktok_comment_replies",
        "tags": [
          "TikTok"
        ],
        "summary": "Comment replies",
        "description": "The replies under one comment, with their likes and authors.\n\nUse it to read a comment's thread. Get `comment_id` from a comment's `cid` in video comments. `reply_to_reply_id` shows which reply a reply answers.\n\n**Pagination.** Up to 50 replies per page. Pass the response's `cursor` back as `cursor` (with the same `url` and `comment_id`); it's null at the end.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/comment-replies"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
            "schema": {
              "description": "The video's URL, e.g. `https://www.tiktok.com/@hubspot/video/7671325437229845774`. Photo post URLs and bare video ids work too.",
              "type": "string"
            },
            "example": "https://www.tiktok.com/@scout2015/video/6718335390845095173"
          },
          {
            "name": "comment_id",
            "in": "query",
            "required": true,
            "description": "The comment's `cid`, from video comments.",
            "schema": {
              "type": "string",
              "pattern": "^\\d{1,21}$",
              "description": "The comment's `cid`, from video comments."
            },
            "example": "6718335906996502534"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string",
              "pattern": "^\\d{1,20}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The replies under one comment, with their likes and authors.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "cid": {
                            "type": "string",
                            "description": "Comment id; pass it as `comment_id` to comment replies."
                          },
                          "text": {
                            "type": "string",
                            "description": "Comment text; empty when the comment is only a photo (see `image_list`) or a sticker."
                          },
                          "create_time": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "digg_count": {
                            "type": "number",
                            "description": "Likes."
                          },
                          "reply_comment_total": {
                            "type": "number",
                            "description": "Replies to this comment. Always 0 on replies."
                          },
                          "comment_language": {
                            "description": "Language as TikTok detects it, e.g. `en`; `un` = undetermined.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author_pin": {
                            "type": "boolean",
                            "description": "Pinned by the video's creator."
                          },
                          "is_author_digged": {
                            "type": "boolean",
                            "description": "Liked by the video's creator."
                          },
                          "reply_id": {
                            "type": "string",
                            "description": "On replies: the comment it belongs to. `0` on top-level comments."
                          },
                          "reply_to_reply_id": {
                            "type": "string",
                            "description": "On replies: the reply it answers, if any. `0` otherwise."
                          },
                          "aweme_id": {
                            "type": "string",
                            "description": "The video's id."
                          },
                          "image_list": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "Full-size image URL (expires after a few weeks)."
                                    },
                                    "width": {
                                      "description": "Width in pixels; null if TikTok doesn't say.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "height": {
                                      "description": "Height in pixels; null if TikTok doesn't say.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "width",
                                    "height"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Photos attached to the comment; null if it has none."
                          },
                          "user": {
                            "type": "object",
                            "properties": {
                              "uid": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "unique_id": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "sec_uid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id."
                              },
                              "avatar_thumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "uid",
                              "unique_id",
                              "nickname",
                              "sec_uid",
                              "avatar_thumb"
                            ],
                            "additionalProperties": false,
                            "description": "Who wrote it."
                          }
                        },
                        "required": [
                          "cid",
                          "text",
                          "create_time",
                          "digg_count",
                          "reply_comment_total",
                          "comment_language",
                          "author_pin",
                          "is_author_digged",
                          "reply_id",
                          "reply_to_reply_id",
                          "aweme_id",
                          "image_list",
                          "user"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Replies in TikTok's order: top replies first, not by date. Replies to a reply follow it."
                    },
                    "total": {
                      "type": "number",
                      "description": "Comments TikTok counts in this thread (may include some it no longer shows)."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "More comments after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "comments",
                    "total",
                    "has_more",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/search/hashtag": {
      "get": {
        "operationId": "tiktok_hashtag_videos",
        "tags": [
          "TikTok"
        ],
        "summary": "Hashtag videos",
        "description": "Videos posted with a hashtag, plus how big the hashtag is: total posts and views.\n\nUse it to research a trend, a niche or a campaign hashtag: which creators post under it, what performs, and how big it is (`hashtag.videoCount` and `hashtag.viewCount`, exact). Videos come in the order tiktok.com's hashtag page shows them: neither newest nor most viewed first, and often months old.\n\n**Pagination.** Up to 30 videos per page. Pass the response's `cursor` back as `cursor` (with the same `hashtag`) for more; `has_more` is false at the end. A few videos can repeat across pages, so dedupe by `id`. At times TikTok shows logged-out visitors only a handful of a hashtag's videos (with `has_more: false`), even for a big one. Full pages come back later.\n\nUnknown hashtags return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/hashtag-videos"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "hashtag",
            "in": "query",
            "required": true,
            "description": "The hashtag, with or without # (e.g. `skincare`), or its tiktok.com/tag/… URL.",
            "schema": {
              "description": "The hashtag, with or without # (e.g. `skincare`), or its tiktok.com/tag/… URL.",
              "type": "string"
            },
            "example": "smallbusiness"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string",
              "pattern": "^\\d{1,20}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Videos posted with a hashtag, plus how big the hashtag is: total posts and views.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "hashtag": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "TikTok's id for the hashtag."
                        },
                        "title": {
                          "type": "string",
                          "description": "The hashtag, without #."
                        },
                        "desc": {
                          "type": "string",
                          "description": "TikTok's description of the hashtag; empty for most."
                        },
                        "videoCount": {
                          "type": "number",
                          "description": "Posts using the hashtag, exact."
                        },
                        "viewCount": {
                          "type": "number",
                          "description": "Total views of those posts, exact."
                        },
                        "isCommerce": {
                          "type": "boolean",
                          "description": "A branded hashtag (a sponsored hashtag challenge)."
                        }
                      },
                      "required": [
                        "id",
                        "title",
                        "desc",
                        "videoCount",
                        "viewCount",
                        "isCommerce"
                      ],
                      "additionalProperties": false,
                      "description": "The hashtag."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `7671325437229845774`."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on tiktok.com."
                          },
                          "desc": {
                            "type": "string",
                            "description": "Caption, hashtags included."
                          },
                          "title": {
                            "description": "A photo post's title, shown above the caption, e.g. `tom & jerry art`; null for videos and untitled posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "createTime": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "textLanguage": {
                            "description": "Caption language as TikTok detects it, e.g. `en`; `un` = undetermined; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "locationCreated": {
                            "description": "Country the post was made in, as a 2-letter code. Only video details have it; null in lists and when unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isAd": {
                            "type": "boolean",
                            "description": "A paid ad (Spark Ad or promoted post)."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "uniqueId": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "secUid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id; other tools ask for it."
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the verified badge."
                              },
                              "privateAccount": {
                                "type": "boolean",
                                "description": "The account is private."
                              },
                              "avatarThumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatarLarger": {
                                "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "uniqueId",
                              "nickname",
                              "secUid",
                              "verified",
                              "privateAccount",
                              "avatarThumb",
                              "avatarLarger"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "stats": {
                            "type": "object",
                            "properties": {
                              "playCount": {
                                "type": "number",
                                "description": "Views."
                              },
                              "diggCount": {
                                "type": "number",
                                "description": "Likes."
                              },
                              "commentCount": {
                                "type": "number",
                                "description": "Comments."
                              },
                              "shareCount": {
                                "type": "number",
                                "description": "Shares."
                              },
                              "collectCount": {
                                "description": "Saves (favorites); null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "repostCount": {
                                "description": "Reposts; null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "playCount",
                              "diggCount",
                              "commentCount",
                              "shareCount",
                              "collectCount",
                              "repostCount"
                            ],
                            "additionalProperties": false,
                            "description": "Engagement when fetched, as tiktok.com gives it: exact for smaller counts, rounded for large ones (e.g. `2500000` views)."
                          },
                          "video": {
                            "type": "object",
                            "properties": {
                              "duration": {
                                "type": "number",
                                "description": "Length in seconds; 0 for photo posts."
                              },
                              "width": {
                                "type": "number",
                                "description": "Width in pixels; 0 for photo posts."
                              },
                              "height": {
                                "type": "number",
                                "description": "Height in pixels; 0 for photo posts."
                              },
                              "definition": {
                                "description": "Quality of the default rendition, e.g. `720p`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cover": {
                                "description": "Cover image URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "dynamicCover": {
                                "description": "Animated cover URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "playUrl": {
                                "description": "MP4 URL that plays without cookies (h264, best quality). It redirects to TikTok's CDN and expires at `expires_at`; null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "expires_at": {
                                "description": "When `playUrl` stops working, Unix seconds; null if unknown.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "duration",
                              "width",
                              "height",
                              "definition",
                              "cover",
                              "dynamicCover",
                              "playUrl",
                              "expires_at"
                            ],
                            "additionalProperties": false,
                            "description": "The video file. For photo posts see `images`."
                          },
                          "music": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Sound id; pass it to song endpoints."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Sound title, e.g. `original sound`."
                                  },
                                  "authorName": {
                                    "description": "Artist, or the creator for original sounds.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "original": {
                                    "type": "boolean",
                                    "description": "An original sound made with this post rather than a track."
                                  },
                                  "duration": {
                                    "description": "Length in seconds.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "playUrl": {
                                    "description": "Audio URL (expires after a few hours); null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "cover": {
                                    "description": "Sound cover image URL; null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "authorName",
                                  "original",
                                  "duration",
                                  "playUrl",
                                  "cover"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The sound; null if the post has none."
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Hashtag without #."
                            },
                            "description": "Hashtags in the caption, without #."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Username without @."
                            },
                            "description": "Usernames @mentioned in the caption."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Image URL (expires after a few days)."
                                },
                                "width": {
                                  "type": "number",
                                  "description": "Width in pixels."
                                },
                                "height": {
                                  "type": "number",
                                  "description": "Height in pixels."
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The slides of a photo post, in order. Empty for videos."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "desc",
                          "title",
                          "createTime",
                          "textLanguage",
                          "locationCreated",
                          "isAd",
                          "author",
                          "stats",
                          "video",
                          "music",
                          "hashtags",
                          "mentions",
                          "images"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Posts, in the order tiktok.com shows them (not newest first)."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "There are more posts after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "hashtag",
                    "videos",
                    "has_more",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/song": {
      "get": {
        "operationId": "tiktok_song",
        "tags": [
          "TikTok"
        ],
        "summary": "Song",
        "description": "A TikTok sound: title, artist, album, length, cover, audio URL and how many videos use it.\n\nUse it to size up a sound before you build content on it: `videoCount` is how many posts use it. `original: true` means a creator's original sound rather than a released track, and `is_commerce_music` is TikTok's flag for sounds cleared for commercial use (the ones business accounts can pick). Get the id from any video's `music.id`, or pass the sound's tiktok.com/music/… URL.\n\nUnknown and removed sounds return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/song"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "clipId",
            "in": "query",
            "required": true,
            "description": "The sound's id, e.g. `7433619007506761744`, or its URL (`https://www.tiktok.com/music/…-<id>`). Every video carries it as `music.id`.",
            "schema": {
              "description": "The sound's id, e.g. `7433619007506761744`, or its URL (`https://www.tiktok.com/music/…-<id>`). Every video carries it as `music.id`.",
              "type": "string"
            },
            "example": "7433619007506761744"
          }
        ],
        "responses": {
          "200": {
            "description": "A TikTok sound: title, artist, album, length, cover, audio URL and how many videos use it.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Sound id."
                    },
                    "url": {
                      "type": "string",
                      "description": "The sound's page on tiktok.com."
                    },
                    "title": {
                      "type": "string",
                      "description": "Sound title, e.g. `original sound` or the track name."
                    },
                    "authorName": {
                      "description": "Artist, or the creator's display name for original sounds.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "album": {
                      "description": "Album of a released track; null for original sounds and when TikTok doesn't say.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "original": {
                      "type": "boolean",
                      "description": "An original sound a creator made, rather than a released track."
                    },
                    "duration": {
                      "description": "Length in seconds (for tracks, the clip TikTok offers); null if unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "cover": {
                      "description": "Cover art URL (may expire after a few days); null if TikTok has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "playUrl": {
                      "description": "Audio URL (may expire after a few hours); null if TikTok has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "videoCount": {
                      "type": "number",
                      "description": "Posts using this sound."
                    },
                    "isCopyrighted": {
                      "type": "boolean",
                      "description": "TikTok marks the sound as copyrighted."
                    },
                    "is_commerce_music": {
                      "type": "boolean",
                      "description": "TikTok's commercial-use flag: cleared for business accounts and ads."
                    },
                    "author": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Numeric user id."
                            },
                            "uniqueId": {
                              "type": "string",
                              "description": "Username (handle), without @."
                            },
                            "nickname": {
                              "type": "string",
                              "description": "Display name."
                            },
                            "secUid": {
                              "type": "string",
                              "description": "TikTok's long, stable user id."
                            },
                            "avatarThumb": {
                              "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "uniqueId",
                            "nickname",
                            "secUid",
                            "avatarThumb"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The TikTok account behind the sound: its creator for original sounds, the artist's account for tracks; null if none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "title",
                    "authorName",
                    "album",
                    "original",
                    "duration",
                    "cover",
                    "playUrl",
                    "videoCount",
                    "isCopyrighted",
                    "is_commerce_music",
                    "author"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/song/videos": {
      "get": {
        "operationId": "tiktok_song_videos",
        "tags": [
          "TikTok"
        ],
        "summary": "Song videos",
        "description": "Videos that use a sound, 30 per page, with stats and creators.\n\nUse it to see how a sound is being used: which creators and brands post with it and how their posts perform. Videos come in the order tiktok.com shows them on the sound's page, roughly most viewed first.\n\n**Pagination.** Up to 30 videos per page. Pass the response's `cursor` back as `cursor` (with the same `clipId`) for more; `has_more` is false at the end. TikTok only lists posts it still shows, so older sounds can list far fewer videos than their `videoCount` in song.\n\nUnknown sounds return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/song-videos"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "clipId",
            "in": "query",
            "required": true,
            "description": "The sound's id, e.g. `7433619007506761744`, or its URL (`https://www.tiktok.com/music/…-<id>`). Every video carries it as `music.id`.",
            "schema": {
              "description": "The sound's id, e.g. `7433619007506761744`, or its URL (`https://www.tiktok.com/music/…-<id>`). Every video carries it as `music.id`.",
              "type": "string"
            },
            "example": "7433619007506761744"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string",
              "pattern": "^\\d{1,20}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Videos that use a sound, 30 per page, with stats and creators.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `7671325437229845774`."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on tiktok.com."
                          },
                          "desc": {
                            "type": "string",
                            "description": "Caption, hashtags included."
                          },
                          "title": {
                            "description": "A photo post's title, shown above the caption, e.g. `tom & jerry art`; null for videos and untitled posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "createTime": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "textLanguage": {
                            "description": "Caption language as TikTok detects it, e.g. `en`; `un` = undetermined; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "locationCreated": {
                            "description": "Country the post was made in, as a 2-letter code. Only video details have it; null in lists and when unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isAd": {
                            "type": "boolean",
                            "description": "A paid ad (Spark Ad or promoted post)."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "uniqueId": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "secUid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id; other tools ask for it."
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the verified badge."
                              },
                              "privateAccount": {
                                "type": "boolean",
                                "description": "The account is private."
                              },
                              "avatarThumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatarLarger": {
                                "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "uniqueId",
                              "nickname",
                              "secUid",
                              "verified",
                              "privateAccount",
                              "avatarThumb",
                              "avatarLarger"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "stats": {
                            "type": "object",
                            "properties": {
                              "playCount": {
                                "type": "number",
                                "description": "Views."
                              },
                              "diggCount": {
                                "type": "number",
                                "description": "Likes."
                              },
                              "commentCount": {
                                "type": "number",
                                "description": "Comments."
                              },
                              "shareCount": {
                                "type": "number",
                                "description": "Shares."
                              },
                              "collectCount": {
                                "description": "Saves (favorites); null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "repostCount": {
                                "description": "Reposts; null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "playCount",
                              "diggCount",
                              "commentCount",
                              "shareCount",
                              "collectCount",
                              "repostCount"
                            ],
                            "additionalProperties": false,
                            "description": "Engagement when fetched, as tiktok.com gives it: exact for smaller counts, rounded for large ones (e.g. `2500000` views)."
                          },
                          "video": {
                            "type": "object",
                            "properties": {
                              "duration": {
                                "type": "number",
                                "description": "Length in seconds; 0 for photo posts."
                              },
                              "width": {
                                "type": "number",
                                "description": "Width in pixels; 0 for photo posts."
                              },
                              "height": {
                                "type": "number",
                                "description": "Height in pixels; 0 for photo posts."
                              },
                              "definition": {
                                "description": "Quality of the default rendition, e.g. `720p`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cover": {
                                "description": "Cover image URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "dynamicCover": {
                                "description": "Animated cover URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "playUrl": {
                                "description": "MP4 URL that plays without cookies (h264, best quality). It redirects to TikTok's CDN and expires at `expires_at`; null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "expires_at": {
                                "description": "When `playUrl` stops working, Unix seconds; null if unknown.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "duration",
                              "width",
                              "height",
                              "definition",
                              "cover",
                              "dynamicCover",
                              "playUrl",
                              "expires_at"
                            ],
                            "additionalProperties": false,
                            "description": "The video file. For photo posts see `images`."
                          },
                          "music": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Sound id; pass it to song endpoints."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Sound title, e.g. `original sound`."
                                  },
                                  "authorName": {
                                    "description": "Artist, or the creator for original sounds.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "original": {
                                    "type": "boolean",
                                    "description": "An original sound made with this post rather than a track."
                                  },
                                  "duration": {
                                    "description": "Length in seconds.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "playUrl": {
                                    "description": "Audio URL (expires after a few hours); null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "cover": {
                                    "description": "Sound cover image URL; null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "authorName",
                                  "original",
                                  "duration",
                                  "playUrl",
                                  "cover"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The sound; null if the post has none."
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Hashtag without #."
                            },
                            "description": "Hashtags in the caption, without #."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Username without @."
                            },
                            "description": "Usernames @mentioned in the caption."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Image URL (expires after a few days)."
                                },
                                "width": {
                                  "type": "number",
                                  "description": "Width in pixels."
                                },
                                "height": {
                                  "type": "number",
                                  "description": "Height in pixels."
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The slides of a photo post, in order. Empty for videos."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "desc",
                          "title",
                          "createTime",
                          "textLanguage",
                          "locationCreated",
                          "isAd",
                          "author",
                          "stats",
                          "video",
                          "music",
                          "hashtags",
                          "mentions",
                          "images"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Posts, in the order tiktok.com shows them (not newest first)."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "There are more posts after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "videos",
                    "has_more",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/ad-library/search": {
      "get": {
        "operationId": "tiktok_ad_library_search",
        "tags": [
          "TikTok"
        ],
        "summary": "Search TikTok Ad Library",
        "description": "Ads shown in the EU, the UK, Switzerland and Turkey that match a keyword or an advertiser, 12 per page.\n\nUse it to see what a brand or a category advertises on TikTok: each ad with its advertiser, caption, video or images, when it ran and roughly how many people saw it. This is TikTok's Ad Library under the EU Digital Services Act, so it only has ads shown in the EU/EEA, Switzerland, the UK and Turkey. Ads shown only in the US or elsewhere aren't in it.\n\nSearch by `query`, a keyword matched against ad text and advertiser names (so resellers show up too), or by `advertiser_name` for one advertiser's ads, spelled as the library shows it (e.g. `NIKE Retail B.V.`, as in a result's `advertiser_name`). Results are ads shown in the last 30 days, most relevant first. `region` narrows them to one country; an ad that ran in several countries appears under each.\n\n**Pagination.** 12 ads per page. Pass the response's `cursor` back as `cursor` (with the same params) for more; `has_more` is false at the end. For keyword searches `total` stops counting at 5,000.\n\nAn `advertiser_name` the library doesn't know returns 404 `not_found`, with close matches in the message.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/ad-library-search"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Keyword, e.g. `running shoes`. Pass this or `advertiser_name`.",
            "schema": {
              "description": "Keyword, e.g. `running shoes`. Pass this or `advertiser_name`.",
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "example": "running shoes"
          },
          {
            "name": "advertiser_name",
            "in": "query",
            "required": false,
            "description": "One advertiser's name as the library shows it, e.g. `NIKE Retail B.V.` Pass this or `query`.",
            "schema": {
              "description": "One advertiser's name as the library shows it, e.g. `NIKE Retail B.V.` Pass this or `query`.",
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "Where the ads were shown: a 2-letter country code (DE, FR, GB, …) of the 33 countries the library covers, or `all`.",
            "schema": {
              "description": "Where the ads were shown: a 2-letter country code (DE, FR, GB, …) of the 33 countries the library covers, or `all`.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "AT",
                "BE",
                "BG",
                "CH",
                "CY",
                "CZ",
                "DE",
                "DK",
                "EE",
                "ES",
                "FI",
                "FR",
                "GB",
                "GR",
                "HR",
                "HU",
                "IE",
                "IS",
                "IT",
                "LI",
                "LT",
                "LU",
                "LV",
                "MT",
                "NL",
                "NO",
                "PL",
                "PT",
                "RO",
                "SE",
                "SI",
                "SK",
                "TR"
              ]
            },
            "example": "DE"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page. Keep every other param the same.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page. Keep every other param the same.",
              "type": "string",
              "pattern": "^[A-Za-z0-9+/=_-]{1,400}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ads shown in the EU, the UK, Switzerland and Turkey that match a keyword or an advertiser, 12 per page.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "ads": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Ad id. Pass it as `ad_id` to TikTok Ad Library ad for targeting and reach."
                          },
                          "url": {
                            "type": "string",
                            "description": "The ad on library.tiktok.com."
                          },
                          "advertiser_name": {
                            "description": "The advertiser as registered with TikTok; null for the few ads published without one.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "title": {
                            "description": "The ad's caption text; null if it has none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "category": {
                            "description": "TikTok's category for the ad, e.g. `Apparel & Accessories` or `Apps`; null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "first_shown": {
                            "type": "number",
                            "description": "First day the ad was shown in the library's countries, Unix seconds (usually midnight UTC; brand-new ads can carry the exact time)."
                          },
                          "last_shown": {
                            "type": "number",
                            "description": "Latest day it was shown, Unix seconds (usually midnight UTC). Yesterday or today for ads still running."
                          },
                          "estimated_audience": {
                            "description": "TikTok's estimate of unique users who saw the ad at least once, as a range such as `10K-100K`; null if not given.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "videos": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "MP4 URL. It redirects to TikTok's CDN and expires about 6 hours after we fetched the ad."
                                },
                                "cover": {
                                  "description": "Cover image URL (expires about 6 hours after we fetched the ad); null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "url",
                                "cover"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The ad's videos, usually one. Empty for image ads."
                          },
                          "image_urls": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Image URL (expires after a few hours)."
                            },
                            "description": "The ad's images, in order. In search results a video ad usually lists its cover here."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "advertiser_name",
                          "title",
                          "category",
                          "first_shown",
                          "last_shown",
                          "estimated_audience",
                          "videos",
                          "image_urls"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Ads, most relevant first."
                    },
                    "total": {
                      "type": "number",
                      "description": "Ads matching the search in the last 30 days. Keyword searches stop counting at 5,000."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "There are more ads after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "ads",
                    "total",
                    "has_more",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/ad-library/ad": {
      "get": {
        "operationId": "tiktok_ad_library_ad",
        "tags": [
          "TikTok"
        ],
        "summary": "TikTok Ad Library ad",
        "description": "One ad from TikTok's EU Ad Library: creative, landing page, advertiser, who paid, targeting and reach by country, age and gender.\n\nUse it to see how an ad was targeted and whom it reached: the countries, ages, genders and interests the advertiser chose, TikTok's estimate of how many users matched, and unique reach per country (split by age and gender for ads shown since June 2026). You also get the landing page, call to action, objective, who paid for the ad and the advertiser's TikTok account.\n\nGet `ad_id` from TikTok Ad Library search, or paste the ad's library.tiktok.com URL. Like the search, it only covers ads shown in the EU/EEA, Switzerland, the UK and Turkey.\n\nUnknown ids return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/ad-library-ad"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "ad_id",
            "in": "query",
            "required": true,
            "description": "The ad's `id` from TikTok Ad Library search, e.g. `1876319908813409`, or its library.tiktok.com/ads/detail/?ad_id=… URL.",
            "schema": {
              "description": "The ad's `id` from TikTok Ad Library search, e.g. `1876319908813409`, or its library.tiktok.com/ads/detail/?ad_id=… URL.",
              "type": "string"
            },
            "example": "1876319908813409"
          }
        ],
        "responses": {
          "200": {
            "description": "One ad from TikTok's EU Ad Library: creative, landing page, advertiser, who paid, targeting and reach by country, age and gender.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Ad id. Pass it as `ad_id` to TikTok Ad Library ad for targeting and reach."
                    },
                    "url": {
                      "type": "string",
                      "description": "The ad on library.tiktok.com."
                    },
                    "advertiser_name": {
                      "description": "The advertiser as registered with TikTok; null for the few ads published without one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "title": {
                      "description": "The ad's caption text; null if it has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "category": {
                      "description": "TikTok's category for the ad, e.g. `Apparel & Accessories` or `Apps`; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "first_shown": {
                      "type": "number",
                      "description": "First day the ad was shown in the library's countries, Unix seconds (usually midnight UTC; brand-new ads can carry the exact time)."
                    },
                    "last_shown": {
                      "type": "number",
                      "description": "Latest day it was shown, Unix seconds (usually midnight UTC). Yesterday or today for ads still running."
                    },
                    "estimated_audience": {
                      "description": "TikTok's estimate of unique users who saw the ad at least once, as a range such as `10K-100K`; null if not given.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string",
                            "description": "MP4 URL. It redirects to TikTok's CDN and expires about 6 hours after we fetched the ad."
                          },
                          "cover": {
                            "description": "Cover image URL (expires about 6 hours after we fetched the ad); null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "url",
                          "cover"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The ad's videos, usually one. Empty for image ads."
                    },
                    "image_urls": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Image URL (expires after a few hours)."
                      },
                      "description": "The ad's images, in order. In search results a video ad usually lists its cover here."
                    },
                    "external_url": {
                      "description": "Where the ad sends people: the landing page, or the app store page for app ads; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "call_to_action": {
                      "description": "The button text, e.g. `Shop now`; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "objective": {
                      "description": "The advertiser's campaign objective, e.g. `Traffic` or `Sales`; null if not given.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "advertiser": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "description": "The advertiser as registered with TikTok.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "adv_biz_ids": {
                          "description": "TikTok's business id for the advertiser, e.g. `6876453864464188162`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "registry_location": {
                          "description": "Country the advertiser is registered in, e.g. `Germany`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "sponsor": {
                          "description": "Who paid for the ad (\"Ad paid for by\"), often an agency or the advertiser itself; null if not given.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "tiktok_user": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "username": {
                                  "type": "string",
                                  "description": "TikTok username (handle), without @. Pass it to the profile endpoint."
                                },
                                "display_name": {
                                  "description": "Display name.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "followers": {
                                  "description": "Followers as TikTok rounds them in the library, e.g. `319.1K`.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "avatar_url": {
                                  "description": "Avatar URL (expires after a few days).",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "url": {
                                  "type": "string",
                                  "description": "The account on tiktok.com."
                                }
                              },
                              "required": [
                                "username",
                                "display_name",
                                "followers",
                                "avatar_url",
                                "url"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The advertiser's TikTok account; null when the ad didn't run from one."
                        }
                      },
                      "required": [
                        "name",
                        "adv_biz_ids",
                        "registry_location",
                        "sponsor",
                        "tiktok_user"
                      ],
                      "additionalProperties": false,
                      "description": "Who ran the ad."
                    },
                    "targeting": {
                      "type": "object",
                      "properties": {
                        "countries": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Countries targeted, as 2-letter codes."
                        },
                        "age": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Age ranges targeted, e.g. `18-24`, `25-34` or `55+` (in any of the countries)."
                        },
                        "gender": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Genders targeted: `female`, `male` and/or `unknown`."
                        },
                        "audience_size": {
                          "description": "TikTok's estimate of how many users matched the targeting, e.g. `3.9M-4.8M`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "interests": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Interest categories targeted, e.g. `Sports`. Empty if none."
                        },
                        "video_interactions": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Categories of videos the audience interacted with. Empty if not used."
                        },
                        "creator_interactions": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Categories of creators the audience followed or watched. Empty if not used."
                        },
                        "languages": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Languages targeted. Empty means any."
                        },
                        "operating_systems": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Operating systems targeted, e.g. `ANDROID`. Empty means any."
                        }
                      },
                      "required": [
                        "countries",
                        "age",
                        "gender",
                        "audience_size",
                        "interests",
                        "video_interactions",
                        "creator_interactions",
                        "languages",
                        "operating_systems"
                      ],
                      "additionalProperties": false,
                      "description": "The main ways the advertiser chose to reach people. TikTok may also have shown the ad for other reasons."
                    },
                    "reach_by_country": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "country": {
                            "type": "string",
                            "description": "2-letter country code."
                          },
                          "users": {
                            "type": "string",
                            "description": "Unique users reached there, e.g. `540K` or a range like `0-1K`."
                          },
                          "by_age_gender": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "age": {
                                  "type": "string",
                                  "description": "Age range, e.g. `18-24` or `55+`."
                                },
                                "gender": {
                                  "type": "string",
                                  "description": "`female`, `male` or `unknown`."
                                },
                                "users": {
                                  "type": "string",
                                  "description": "Unique users reached in this group, e.g. `302K` or `0-1K`."
                                }
                              },
                              "required": [
                                "age",
                                "gender",
                                "users"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Reach split by age and gender. TikTok only publishes it for ads shown since June 2026; empty otherwise."
                          }
                        },
                        "required": [
                          "country",
                          "users",
                          "by_age_gender"
                        ],
                        "additionalProperties": false,
                        "description": "Reach in one country."
                      },
                      "description": "Unique users reached, per country."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "advertiser_name",
                    "title",
                    "category",
                    "first_shown",
                    "last_shown",
                    "estimated_audience",
                    "videos",
                    "image_urls",
                    "external_url",
                    "call_to_action",
                    "objective",
                    "advertiser",
                    "targeting",
                    "reach_by_country"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/user/live": {
      "get": {
        "operationId": "tiktok_live",
        "tags": [
          "TikTok"
        ],
        "summary": "Live status",
        "description": "Whether a public creator is live, with the current room title, viewers and start time.\n\nUse it to see whether a creator is live right now, before a campaign or a live collaboration. The room id on a profile can belong to a stream that already ended, so this endpoint checks the room itself.\n\nOnly an active stream returns room details. Offline accounts return `is_live: false` and null room fields. Results refresh every 30 seconds.\n\nUnknown accounts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/live"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
            "schema": {
              "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
              "type": "string"
            },
            "example": "tiktok"
          }
        ],
        "responses": {
          "200": {
            "description": "Whether a public creator is live, with the current room title, viewers and start time.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Numeric user id."
                        },
                        "uniqueId": {
                          "type": "string",
                          "description": "Username (handle), without @."
                        },
                        "nickname": {
                          "type": "string",
                          "description": "Display name."
                        },
                        "avatarThumb": {
                          "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has the verified badge."
                        }
                      },
                      "required": [
                        "id",
                        "uniqueId",
                        "nickname",
                        "avatarThumb",
                        "verified"
                      ],
                      "additionalProperties": false,
                      "description": "The creator."
                    },
                    "is_live": {
                      "type": "boolean",
                      "description": "TikTok reports an active livestream (room status 2)."
                    },
                    "room_id": {
                      "description": "Current live room id; null when offline.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "title": {
                      "description": "Current stream title; null when offline or unavailable.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "started_at": {
                      "description": "Current stream start time, Unix seconds; null when offline or unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "viewer_count": {
                      "description": "Current concurrent viewers; null when offline or unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "total_joins": {
                      "description": "Total joins since this stream started; null when offline or unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "user",
                    "is_live",
                    "room_id",
                    "title",
                    "started_at",
                    "viewer_count",
                    "total_joins"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/user/stories": {
      "get": {
        "operationId": "tiktok_stories",
        "tags": [
          "TikTok"
        ],
        "summary": "Public stories",
        "description": "A creator's active public stories, with captions, media and expiration times.\n\nUse it to see the short-lived stories a public creator posts alongside regular videos. Each story has the usual post fields plus `expires_at`.\n\nYou get up to 20 stories, oldest first, in a single page; this endpoint doesn't paginate. `has_more` is true when TikTok reports more than that. An account with no active stories returns an empty list. Only stories TikTok shows logged-out visitors are included, never private ones.\n\nUnknown accounts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/stories"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
            "schema": {
              "description": "TikTok username, with or without @ (e.g. `nike`), or the profile URL.",
              "type": "string"
            },
            "example": "nono95118"
          }
        ],
        "responses": {
          "200": {
            "description": "A creator's active public stories, with captions, media and expiration times.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Numeric user id."
                        },
                        "uniqueId": {
                          "type": "string",
                          "description": "Username (handle), without @."
                        },
                        "nickname": {
                          "type": "string",
                          "description": "Display name."
                        },
                        "avatarThumb": {
                          "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has the verified badge."
                        }
                      },
                      "required": [
                        "id",
                        "uniqueId",
                        "nickname",
                        "avatarThumb",
                        "verified"
                      ],
                      "additionalProperties": false,
                      "description": "The creator."
                    },
                    "stories": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `7671325437229845774`."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on tiktok.com."
                          },
                          "desc": {
                            "type": "string",
                            "description": "Caption, hashtags included."
                          },
                          "title": {
                            "description": "A photo post's title, shown above the caption, e.g. `tom & jerry art`; null for videos and untitled posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "createTime": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "textLanguage": {
                            "description": "Caption language as TikTok detects it, e.g. `en`; `un` = undetermined; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "locationCreated": {
                            "description": "Country the post was made in, as a 2-letter code. Only video details have it; null in lists and when unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isAd": {
                            "type": "boolean",
                            "description": "A paid ad (Spark Ad or promoted post)."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "uniqueId": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "secUid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id; other tools ask for it."
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the verified badge."
                              },
                              "privateAccount": {
                                "type": "boolean",
                                "description": "The account is private."
                              },
                              "avatarThumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatarLarger": {
                                "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "uniqueId",
                              "nickname",
                              "secUid",
                              "verified",
                              "privateAccount",
                              "avatarThumb",
                              "avatarLarger"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "stats": {
                            "type": "object",
                            "properties": {
                              "playCount": {
                                "type": "number",
                                "description": "Views."
                              },
                              "diggCount": {
                                "type": "number",
                                "description": "Likes."
                              },
                              "commentCount": {
                                "type": "number",
                                "description": "Comments."
                              },
                              "shareCount": {
                                "type": "number",
                                "description": "Shares."
                              },
                              "collectCount": {
                                "description": "Saves (favorites); null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "repostCount": {
                                "description": "Reposts; null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "playCount",
                              "diggCount",
                              "commentCount",
                              "shareCount",
                              "collectCount",
                              "repostCount"
                            ],
                            "additionalProperties": false,
                            "description": "Engagement when fetched, as tiktok.com gives it: exact for smaller counts, rounded for large ones (e.g. `2500000` views)."
                          },
                          "video": {
                            "type": "object",
                            "properties": {
                              "duration": {
                                "type": "number",
                                "description": "Length in seconds; 0 for photo posts."
                              },
                              "width": {
                                "type": "number",
                                "description": "Width in pixels; 0 for photo posts."
                              },
                              "height": {
                                "type": "number",
                                "description": "Height in pixels; 0 for photo posts."
                              },
                              "definition": {
                                "description": "Quality of the default rendition, e.g. `720p`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cover": {
                                "description": "Cover image URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "dynamicCover": {
                                "description": "Animated cover URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "playUrl": {
                                "description": "MP4 URL that plays without cookies (h264, best quality). It redirects to TikTok's CDN and expires at `expires_at`; null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "expires_at": {
                                "description": "When `playUrl` stops working, Unix seconds; null if unknown.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "duration",
                              "width",
                              "height",
                              "definition",
                              "cover",
                              "dynamicCover",
                              "playUrl",
                              "expires_at"
                            ],
                            "additionalProperties": false,
                            "description": "The video file. For photo posts see `images`."
                          },
                          "music": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Sound id; pass it to song endpoints."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Sound title, e.g. `original sound`."
                                  },
                                  "authorName": {
                                    "description": "Artist, or the creator for original sounds.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "original": {
                                    "type": "boolean",
                                    "description": "An original sound made with this post rather than a track."
                                  },
                                  "duration": {
                                    "description": "Length in seconds.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "playUrl": {
                                    "description": "Audio URL (expires after a few hours); null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "cover": {
                                    "description": "Sound cover image URL; null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "authorName",
                                  "original",
                                  "duration",
                                  "playUrl",
                                  "cover"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The sound; null if the post has none."
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Hashtag without #."
                            },
                            "description": "Hashtags in the caption, without #."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Username without @."
                            },
                            "description": "Usernames @mentioned in the caption."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Image URL (expires after a few days)."
                                },
                                "width": {
                                  "type": "number",
                                  "description": "Width in pixels."
                                },
                                "height": {
                                  "type": "number",
                                  "description": "Height in pixels."
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The slides of a photo post, in order. Empty for videos."
                          },
                          "expires_at": {
                            "type": "number",
                            "description": "When this story expires, Unix seconds."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "desc",
                          "title",
                          "createTime",
                          "textLanguage",
                          "locationCreated",
                          "isAd",
                          "author",
                          "stats",
                          "video",
                          "music",
                          "hashtags",
                          "mentions",
                          "images",
                          "expires_at"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Active public stories, oldest first, up to 20."
                    },
                    "total_count": {
                      "type": "number",
                      "description": "Stories TikTok reported when fetched. It can be more than this page holds."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "TikTok reports more stories than this page holds. This endpoint doesn't paginate."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "user",
                    "stories",
                    "total_count",
                    "has_more"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/product": {
      "get": {
        "operationId": "tiktok_product",
        "tags": [
          "TikTok"
        ],
        "summary": "TikTok Shop product",
        "description": "A US TikTok Shop product's price, images, seller, variants, sales and review totals.\n\nUse it to check a product sold on the US TikTok Shop: its description, price, variants and stock, seller, category, sales and rating. Pass the product's shop.tiktok.com URL or its id.\n\nPrices are decimal strings, as the logged-out US storefront shows them. Discounts at checkout and shipping can differ. Sales and review counts are lifetime totals, not a history, and review text isn't included. US products only.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/product"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "US product URL on shop.tiktok.com/us/pdp/… or its numeric product id.",
            "schema": {
              "description": "US product URL on shop.tiktok.com/us/pdp/… or its numeric product id.",
              "type": "string"
            },
            "example": "https://shop.tiktok.com/us/pdp/biodance-collagen-mask-pdrn-sea-kelp-overnight-hydration/1732049122233848586"
          }
        ],
        "responses": {
          "200": {
            "description": "A US TikTok Shop product's price, images, seller, variants, sales and review totals.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "TikTok Shop product id."
                    },
                    "url": {
                      "type": "string",
                      "description": "The product's page on the US storefront."
                    },
                    "region": {
                      "type": "string",
                      "const": "US",
                      "description": "Storefront country. Always `US`."
                    },
                    "title": {
                      "type": "string",
                      "description": "Product name."
                    },
                    "description": {
                      "type": "string",
                      "description": "Public product description as plain text."
                    },
                    "sold_count": {
                      "description": "Lifetime items sold globally, excluding returns; null when unavailable.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "price": {
                      "type": "object",
                      "properties": {
                        "currency": {
                          "description": "Currency code, e.g. USD; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "amount": {
                          "description": "Lowest variant sale price as a decimal string; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "original_amount": {
                          "description": "Lowest variant original price before discount, as a decimal string; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "display": {
                          "description": "Sale price formatted as the storefront displays it; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "currency",
                        "amount",
                        "original_amount",
                        "display"
                      ],
                      "additionalProperties": false,
                      "description": "Public logged-out storefront price."
                    },
                    "images": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string",
                            "description": "Product image URL."
                          },
                          "width": {
                            "description": "Image width in pixels; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "height": {
                            "description": "Image height in pixels; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "url",
                          "width",
                          "height"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Product images in gallery order."
                    },
                    "categories": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Category id."
                          },
                          "name": {
                            "type": "string",
                            "description": "Category name."
                          }
                        },
                        "required": [
                          "id",
                          "name"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Category hierarchy, broadest first."
                    },
                    "specifications": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Specification name."
                          },
                          "value": {
                            "type": "string",
                            "description": "Specification value."
                          }
                        },
                        "required": [
                          "name",
                          "value"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Product specifications, such as brand and ingredients."
                    },
                    "seller": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Seller id."
                        },
                        "name": {
                          "description": "Seller storefront name; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "url": {
                          "description": "Seller storefront URL; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "avatar": {
                          "description": "Seller avatar URL; null when unavailable.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "rating": {
                          "description": "Seller rating out of 5; null when unavailable.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "follower_count": {
                          "description": "Store followers; null when unavailable.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "product_count": {
                          "description": "Products in the store; null when unavailable.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "url",
                        "avatar",
                        "rating",
                        "follower_count",
                        "product_count"
                      ],
                      "additionalProperties": false,
                      "description": "The seller."
                    },
                    "rating": {
                      "description": "Product rating out of 5; null when unavailable.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "review_count": {
                      "description": "Total product reviews; null when unavailable.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "variants": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "SKU id."
                          },
                          "stock": {
                            "description": "Units in stock that TikTok shows for this variant; null when unavailable.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "price": {
                            "description": "Variant sale price as a decimal string; null when unavailable.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "currency": {
                            "description": "Variant currency code; null when unavailable.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "properties": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string",
                                  "description": "Option name."
                                },
                                "value": {
                                  "type": "string",
                                  "description": "Option value."
                                }
                              },
                              "required": [
                                "name",
                                "value"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Variant options, such as size or color."
                          }
                        },
                        "required": [
                          "id",
                          "stock",
                          "price",
                          "currency",
                          "properties"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Publicly listed product variants."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "region",
                    "title",
                    "description",
                    "sold_count",
                    "price",
                    "images",
                    "categories",
                    "specifications",
                    "seller",
                    "rating",
                    "review_count",
                    "variants"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/search/keyword": {
      "get": {
        "operationId": "tiktok_search_keyword",
        "tags": [
          "TikTok"
        ],
        "summary": "Search videos",
        "description": "Videos matching a keyword, as TikTok's search ranks them, 20 per page.\n\nUse it to find what's posted about a product, a brand or a topic: each video with its views, likes, comments, shares, caption, creator and a playable MP4 URL. Results come in the order tiktok.com's search shows a logged-out US visitor, most relevant first; they can include paid posts (`isAd: true`).\n\n**Pagination.** 20 videos per page. Pass the response's `cursor` back as `cursor` (with the same `query`) for more; `has_more` is false at the end. TikTok's ranking shifts between calls, so a video can repeat across pages: dedupe by `id`.\n\nTikTok offers logged-out visitors no date or sort filters, so this endpoint has none. A keyword nothing matches returns an empty `videos` list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/search-keyword"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "What to search for, e.g. `running shoes`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100,
              "description": "What to search for, e.g. `running shoes`."
            },
            "example": "running shoes"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Videos matching a keyword, as TikTok's search ranks them, 20 per page.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Video id, e.g. `7671325437229845774`."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on tiktok.com."
                          },
                          "desc": {
                            "type": "string",
                            "description": "Caption, hashtags included."
                          },
                          "title": {
                            "description": "A photo post's title, shown above the caption, e.g. `tom & jerry art`; null for videos and untitled posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "createTime": {
                            "type": "number",
                            "description": "Posted at, Unix seconds."
                          },
                          "textLanguage": {
                            "description": "Caption language as TikTok detects it, e.g. `en`; `un` = undetermined; null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "locationCreated": {
                            "description": "Country the post was made in, as a 2-letter code. Only video details have it; null in lists and when unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "isAd": {
                            "type": "boolean",
                            "description": "A paid ad (Spark Ad or promoted post)."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Numeric user id."
                              },
                              "uniqueId": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "nickname": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "secUid": {
                                "type": "string",
                                "description": "TikTok's long, stable user id; other tools ask for it."
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the verified badge."
                              },
                              "privateAccount": {
                                "type": "boolean",
                                "description": "The account is private."
                              },
                              "avatarThumb": {
                                "description": "Small avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatarLarger": {
                                "description": "Large avatar URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "uniqueId",
                              "nickname",
                              "secUid",
                              "verified",
                              "privateAccount",
                              "avatarThumb",
                              "avatarLarger"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "stats": {
                            "type": "object",
                            "properties": {
                              "playCount": {
                                "type": "number",
                                "description": "Views."
                              },
                              "diggCount": {
                                "type": "number",
                                "description": "Likes."
                              },
                              "commentCount": {
                                "type": "number",
                                "description": "Comments."
                              },
                              "shareCount": {
                                "type": "number",
                                "description": "Shares."
                              },
                              "collectCount": {
                                "description": "Saves (favorites); null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "repostCount": {
                                "description": "Reposts; null where TikTok doesn't show it.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "playCount",
                              "diggCount",
                              "commentCount",
                              "shareCount",
                              "collectCount",
                              "repostCount"
                            ],
                            "additionalProperties": false,
                            "description": "Engagement when fetched, as tiktok.com gives it: exact for smaller counts, rounded for large ones (e.g. `2500000` views)."
                          },
                          "video": {
                            "type": "object",
                            "properties": {
                              "duration": {
                                "type": "number",
                                "description": "Length in seconds; 0 for photo posts."
                              },
                              "width": {
                                "type": "number",
                                "description": "Width in pixels; 0 for photo posts."
                              },
                              "height": {
                                "type": "number",
                                "description": "Height in pixels; 0 for photo posts."
                              },
                              "definition": {
                                "description": "Quality of the default rendition, e.g. `720p`.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "cover": {
                                "description": "Cover image URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "dynamicCover": {
                                "description": "Animated cover URL (expires after a few days); null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "playUrl": {
                                "description": "MP4 URL that plays without cookies (h264, best quality). It redirects to TikTok's CDN and expires at `expires_at`; null if TikTok has none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "expires_at": {
                                "description": "When `playUrl` stops working, Unix seconds; null if unknown.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "duration",
                              "width",
                              "height",
                              "definition",
                              "cover",
                              "dynamicCover",
                              "playUrl",
                              "expires_at"
                            ],
                            "additionalProperties": false,
                            "description": "The video file. For photo posts see `images`."
                          },
                          "music": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Sound id; pass it to song endpoints."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Sound title, e.g. `original sound`."
                                  },
                                  "authorName": {
                                    "description": "Artist, or the creator for original sounds.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "original": {
                                    "type": "boolean",
                                    "description": "An original sound made with this post rather than a track."
                                  },
                                  "duration": {
                                    "description": "Length in seconds.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "playUrl": {
                                    "description": "Audio URL (expires after a few hours); null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "cover": {
                                    "description": "Sound cover image URL; null if TikTok has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "title",
                                  "authorName",
                                  "original",
                                  "duration",
                                  "playUrl",
                                  "cover"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The sound; null if the post has none."
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Hashtag without #."
                            },
                            "description": "Hashtags in the caption, without #."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Username without @."
                            },
                            "description": "Usernames @mentioned in the caption."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Image URL (expires after a few days)."
                                },
                                "width": {
                                  "type": "number",
                                  "description": "Width in pixels."
                                },
                                "height": {
                                  "type": "number",
                                  "description": "Height in pixels."
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The slides of a photo post, in order. Empty for videos."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "desc",
                          "title",
                          "createTime",
                          "textLanguage",
                          "locationCreated",
                          "isAd",
                          "author",
                          "stats",
                          "video",
                          "music",
                          "hashtags",
                          "mentions",
                          "images"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Videos, most relevant first."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "There are more videos after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "videos",
                    "has_more",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/shop/products": {
      "get": {
        "operationId": "tiktok_shop_products",
        "tags": [
          "TikTok"
        ],
        "summary": "TikTok Shop store products",
        "description": "A US TikTok Shop store's products with prices, ratings and sales, 20 per page, plus the store's totals.\n\nUse it to audit a brand's TikTok Shop catalog: every product it sells with price, discount, rating, reviews and lifetime sales, and the store's own followers, rating and sales. Products come in the store page's order, best sellers first.\n\nPass the store's URL (`https://www.tiktok.com/shop/store/<name>/<id>`, or its shop.tiktok.com/us/store/… form) or its seller id, which every TikTok Shop product carries as `seller.id`.\n\n**Pagination.** 20 products per page. Pass the response's `cursor` back as `cursor` (with the same `url`) for more; `has_more` is false at the end.\n\nUS stores only. An unknown store returns 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/shop-products"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The store's URL, e.g. `https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079`, or its numeric seller id.",
            "schema": {
              "description": "The store's URL, e.g. `https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079`, or its numeric seller id.",
              "type": "string"
            },
            "example": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string",
              "pattern": "^\\d{1,5}_[A-Za-z0-9+/]{4,400}={0,2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A US TikTok Shop store's products with prices, ratings and sales, 20 per page, plus the store's totals.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "shop": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Seller id."
                        },
                        "name": {
                          "type": "string",
                          "description": "Store name."
                        },
                        "url": {
                          "type": "string",
                          "description": "The store on tiktok.com."
                        },
                        "logo": {
                          "description": "Store logo URL; null if none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "label": {
                          "description": "TikTok's badge for the store, e.g. `OFFICIAL SHOP`; null if none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "rating": {
                          "description": "Store rating out of 5; null when unavailable.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "review_count": {
                          "description": "Product reviews across the store.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "sold_count": {
                          "description": "Lifetime items sold across the store.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "follower_count": {
                          "description": "Store followers.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "video_count": {
                          "description": "Videos featuring the store's products.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "product_count": {
                          "description": "Products on sale.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "tiktok_user_id": {
                          "description": "Numeric id of the brand's official TikTok account; null if none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "url",
                        "logo",
                        "label",
                        "rating",
                        "review_count",
                        "sold_count",
                        "follower_count",
                        "video_count",
                        "product_count",
                        "tiktok_user_id"
                      ],
                      "additionalProperties": false,
                      "description": "The store."
                    },
                    "products": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "TikTok Shop product id. Pass it to TikTok Shop product for variants, description and specifications."
                          },
                          "title": {
                            "type": "string",
                            "description": "Product name."
                          },
                          "url": {
                            "type": "string",
                            "description": "The product on shop.tiktok.com."
                          },
                          "image": {
                            "description": "Main product image URL; null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "price": {
                            "type": "object",
                            "properties": {
                              "currency": {
                                "description": "Currency code, e.g. `USD`; null when unavailable.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "amount": {
                                "description": "Lowest variant sale price as a decimal string, e.g. `19.47`; null when unavailable.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "original_amount": {
                                "description": "Price before discount as a decimal string; null without a discount.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "discount": {
                                "description": "Discount as TikTok shows it, e.g. `21%`; null without one.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "currency",
                              "amount",
                              "original_amount",
                              "discount"
                            ],
                            "additionalProperties": false,
                            "description": "Logged-out US storefront price; checkout discounts and shipping can differ."
                          },
                          "rating": {
                            "description": "Product rating out of 5; null without reviews.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "review_count": {
                            "description": "Product reviews; null when unavailable.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "sold_count": {
                            "description": "Lifetime items sold; null when unavailable.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "seller": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Seller id. Pass it as `url` to TikTok Shop store products for the whole catalog."
                              },
                              "name": {
                                "description": "Store name; null when unavailable.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "name"
                            ],
                            "additionalProperties": false,
                            "description": "The store selling it."
                          }
                        },
                        "required": [
                          "id",
                          "title",
                          "url",
                          "image",
                          "price",
                          "rating",
                          "review_count",
                          "sold_count",
                          "seller"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Products, in the store page's order."
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "The store has more products after this page."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "shop",
                    "products",
                    "has_more",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/tiktok/shop/search/suggestions": {
      "get": {
        "operationId": "tiktok_shop_suggestions",
        "tags": [
          "TikTok"
        ],
        "summary": "TikTok Shop search suggestions",
        "description": "What TikTok Shop's search box suggests for a keyword: the longer queries US shoppers type.\n\nUse it for keyword and demand research: the autocomplete phrases TikTok Shop offers for a seed keyword, in its order, up to 15. Brand and store names show up too (e.g. `The Collagen Co.` for `collagen`). Suggestions come from the logged-out US storefront.\n\nA keyword TikTok has no suggestions for returns an empty list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/tiktok/shop-suggestions"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "The seed keyword, e.g. `collagen`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100,
              "description": "The seed keyword, e.g. `collagen`."
            },
            "example": "collagen"
          }
        ],
        "responses": {
          "200": {
            "description": "What TikTok Shop's search box suggests for a keyword: the longer queries US shoppers type.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "suggestions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "A suggested search."
                      },
                      "description": "Suggested searches, in TikTok's order."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "suggestions"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/adLibrary/advertisers/search": {
      "get": {
        "operationId": "google_search_advertisers",
        "tags": [
          "Google"
        ],
        "summary": "Search Google advertisers",
        "description": "Find an advertiser's Google Ads id by brand name, with how many ads they run, plus matching websites.\n\nUse it to turn a brand name into the `advertiser_id` that company ads (google_company_ads) needs, or to find a website to pass there as `domain`. Big brands often have one advertiser per country or agency. Pick one by `region` and `number_of_ads_estimate`.\n\nYou get the same suggestions as the search box on adstransparency.google.com: up to 10 advertisers and 10 websites, in one call. Only ads shown in `region` (default US) are counted, so the list changes by region. Pass ALL to count every region.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/search-advertisers"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Brand or advertiser name, e.g. `nike`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "description": "Brand or advertiser name, e.g. `nike`."
            },
            "example": "nike"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "Count only ads shown in this country: a 2-letter code (US, GB, DE…), or ALL for anywhere.",
            "schema": {
              "description": "Count only ads shown in this country: a 2-letter code (US, GB, DE…), or ALL for anywhere.",
              "default": "US",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Find an advertiser's Google Ads id by brand name, with how many ads they run, plus matching websites.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "advertisers": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "The advertiser's verified name, e.g. `Nike, Inc.`."
                          },
                          "advertiser_id": {
                            "type": "string",
                            "description": "The advertiser's id (`AR…`). Pass it as `advertiser_id` to company ads."
                          },
                          "region": {
                            "description": "Country the advertiser is based in, as a 2-letter code.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "number_of_ads_estimate": {
                            "description": "How many ads they have in `region`: the lower end of Google's range (exact for small advertisers).",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "number_of_ads_range": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "min": {
                                    "type": "number",
                                    "description": "Lower bound of the ad count."
                                  },
                                  "max": {
                                    "type": "number",
                                    "description": "Upper bound of the ad count."
                                  }
                                },
                                "required": [
                                  "min",
                                  "max"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The ad count as the range Google shows, e.g. 9000–10000; null when it gives none."
                          },
                          "is_verified": {
                            "type": "boolean",
                            "description": "false when Google marks the advertiser as not yet verified."
                          }
                        },
                        "required": [
                          "name",
                          "advertiser_id",
                          "region",
                          "number_of_ads_estimate",
                          "number_of_ads_range",
                          "is_verified"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching advertisers, best match first."
                    },
                    "websites": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "domain": {
                            "type": "string",
                            "description": "A website with ads, e.g. `nike.com`. Pass it as `domain` to company ads."
                          }
                        },
                        "required": [
                          "domain"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Websites matching the query."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "advertisers",
                    "websites"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/company/ads": {
      "get": {
        "operationId": "google_company_ads",
        "tags": [
          "Google"
        ],
        "summary": "Google ads by company",
        "description": "Every ad an advertiser or website runs on Google Search, YouTube, Maps, Play and Shopping, from the Ads Transparency Center.\n\nUse it to study a competitor's Google and YouTube ads: formats, run dates and how long each ad has run. Pass a `domain` such as nike.com to get every advertiser promoting it, or an `advertiser_id` from search advertisers (google_search_advertisers).\n\nFilter by region, platform, format and date range. `topic=political` lists election ads with their spend and impressions; it needs a `region`. For an ad's text, landing page and per-country stats, pass its ids to ad details (google_ad).\n\n**Pagination.** Up to 100 ads per page. Pass `cursor` back with the same filters for the next page. It's null on the last page. Date ranges that start more than about a year ago come back empty.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/company-ads"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "domain",
            "in": "query",
            "required": false,
            "description": "The advertiser's website, e.g. `nike.com`. Required unless you pass `advertiser_id`.",
            "schema": {
              "description": "The advertiser's website, e.g. `nike.com`. Required unless you pass `advertiser_id`.",
              "type": "string"
            },
            "example": "nike.com"
          },
          {
            "name": "advertiser_id",
            "in": "query",
            "required": false,
            "description": "The advertiser's id, e.g. `AR16735076323512287233` (Nike, Inc.). Required unless you pass `domain`.",
            "schema": {
              "description": "The advertiser's id, e.g. `AR16735076323512287233` (Nike, Inc.). Required unless you pass `domain`.",
              "type": "string",
              "pattern": "^AR\\d{1,30}$"
            }
          },
          {
            "name": "topic",
            "in": "query",
            "required": false,
            "description": "`political` lists only election ads (with spend and impressions); it needs a `region`.",
            "schema": {
              "description": "`political` lists only election ads (with spend and impressions); it needs a `region`.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "political"
              ]
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "Only ads shown in this country: a 2-letter code (US, GB, DE…), or ALL for anywhere.",
            "schema": {
              "description": "Only ads shown in this country: a 2-letter code (US, GB, DE…), or ALL for anywhere.",
              "default": "ALL",
              "type": "string"
            },
            "example": "US"
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "description": "Only ads shown on or after this date (YYYY-MM-DD).",
            "schema": {
              "description": "Only ads shown on or after this date (YYYY-MM-DD).",
              "type": "string"
            }
          },
          {
            "name": "end_date",
            "in": "query",
            "required": false,
            "description": "Only ads shown on or before this date (YYYY-MM-DD).",
            "schema": {
              "description": "Only ads shown on or before this date (YYYY-MM-DD).",
              "type": "string"
            }
          },
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "description": "Only ads shown on this Google product.",
            "schema": {
              "description": "Only ads shown on this Google product.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "google_maps",
                "google_play",
                "google_search",
                "google_shopping",
                "youtube"
              ]
            }
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "Only ads in this format.",
            "schema": {
              "description": "Only ads in this format.",
              "default": "all",
              "type": "string",
              "enum": [
                "all",
                "text",
                "image",
                "video"
              ]
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, for the next page. Keep every other param the same.",
            "schema": {
              "description": "The `cursor` from the previous response, for the next page. Keep every other param the same.",
              "type": "string",
              "minLength": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Every ad an advertiser or website runs on Google Search, YouTube, Maps, Play and Shopping, from the Ads Transparency Center.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "ads": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "advertiserId": {
                            "type": "string",
                            "description": "The advertiser's id (`AR…`). Pass it as `advertiser_id` to company ads."
                          },
                          "creativeId": {
                            "type": "string",
                            "description": "The ad's id (`CR…`). Pass it with `advertiser_id` as `creative_id` to ad details."
                          },
                          "format": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "text",
                                  "image",
                                  "video"
                                ]
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "`text`, `image` or `video`. Google often saves text ads as a picture of the ad."
                          },
                          "adUrl": {
                            "type": "string",
                            "description": "The ad's page on the Ads Transparency Center."
                          },
                          "advertiserName": {
                            "description": "The advertiser's verified name, e.g. `Nike, Inc.`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "domain": {
                            "description": "The website this ad matched, on domain searches; null on advertiser searches.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "imageUrl": {
                            "description": "A picture of the ad, for image ads and for text ads Google saved as an image. null when the ad only has a live preview (`previewUrl`).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "previewUrl": {
                            "description": "Google's live preview of the ad: a script the Transparency Center renders. null when there's an `imageUrl`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "firstShown": {
                            "description": "When the ad was first shown, ISO 8601 (UTC).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lastShown": {
                            "description": "When the ad was last shown, ISO 8601 (UTC). Today's date for ads still running.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "daysShown": {
                            "description": "How many days the ad has been shown. A long run usually means the ad works.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "overallImpressions": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "min": {
                                    "type": "number",
                                    "description": "Lower bound of impressions."
                                  },
                                  "max": {
                                    "type": "number",
                                    "description": "Upper bound of impressions."
                                  }
                                },
                                "required": [
                                  "min",
                                  "max"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Impressions as the range Google reports. Political ads only; null otherwise."
                          },
                          "spend": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "currency": {
                                    "type": "string",
                                    "description": "Currency code, e.g. USD."
                                  },
                                  "lower": {
                                    "type": "number",
                                    "description": "Lower bound of the spend, in `currency`."
                                  },
                                  "upper": {
                                    "type": "number",
                                    "description": "Upper bound of the spend, in `currency`."
                                  }
                                },
                                "required": [
                                  "currency",
                                  "lower",
                                  "upper"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Spend as the range Google reports. Political ads only; null otherwise."
                          },
                          "politicalRegions": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Regions where it ran as an election ad, as 2-letter codes, e.g. [\"US\"]; null for other ads."
                          }
                        },
                        "required": [
                          "advertiserId",
                          "creativeId",
                          "format",
                          "adUrl",
                          "advertiserName",
                          "domain",
                          "imageUrl",
                          "previewUrl",
                          "firstShown",
                          "lastShown",
                          "daysShown",
                          "overallImpressions",
                          "spend",
                          "politicalRegions"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The ads in Google's order: roughly most recently shown first."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "number_of_ads_estimate": {
                      "description": "How many ads match, as Google estimates it: the lower end of its range, or the exact count when it gives one.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "number_of_ads_range": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "min": {
                              "type": "number",
                              "description": "Lower bound of the ad count."
                            },
                            "max": {
                              "type": "number",
                              "description": "Upper bound of the ad count."
                            }
                          },
                          "required": [
                            "min",
                            "max"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The ad count as the range Google shows (e.g. 7000–8000); null when it gives none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "ads",
                    "cursor",
                    "number_of_ads_estimate",
                    "number_of_ads_range"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/ad": {
      "get": {
        "operationId": "google_ad",
        "tags": [
          "Google"
        ],
        "summary": "Google ad details",
        "description": "One ad from Google's Ads Transparency Center: every version of the creative, where it ran and, for political ads, spend and targeting.\n\nUse it after company ads (google_company_ads) to see one ad's versions, the countries it ran in and its landing page. Pass the ad's Transparency Center link as `url`, or both `advertiser_id` and `creative_id`.\n\nEach version has an `imageUrl` when Google saved it as a picture, and a `previewUrl` otherwise. For text and video ads we also read one live preview to get the headline, description, landing page and YouTube video. Text that only exists inside an image stays null, since we don't read text from images.\n\nGoogle publishes overall impressions, spend and targeting for political ads only. Per-country impressions are also published for ads shown in the EU.\n\nReturns 404 `not_found` if the ad doesn't exist.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/ad"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "The ad's Transparency Center link, e.g. `https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR11071274990039990273`. Required unless you pass both ids.",
            "schema": {
              "description": "The ad's Transparency Center link, e.g. `https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR11071274990039990273`. Required unless you pass both ids.",
              "type": "string"
            },
            "example": "https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR11071274990039990273?region=US"
          },
          {
            "name": "advertiser_id",
            "in": "query",
            "required": false,
            "description": "The advertiser's id (`AR…`), with `creative_id`, instead of `url`.",
            "schema": {
              "description": "The advertiser's id (`AR…`), with `creative_id`, instead of `url`.",
              "type": "string",
              "pattern": "^AR\\d{1,30}$"
            }
          },
          {
            "name": "creative_id",
            "in": "query",
            "required": false,
            "description": "The ad's id (`CR…`), with `advertiser_id`, instead of `url`.",
            "schema": {
              "description": "The ad's id (`CR…`), with `advertiser_id`, instead of `url`.",
              "type": "string",
              "pattern": "^CR\\d{1,30}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One ad from Google's Ads Transparency Center: every version of the creative, where it ran and, for political ads, spend and targeting.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "advertiserId": {
                      "type": "string",
                      "description": "The advertiser's id (`AR…`). Pass it as `advertiser_id` to company ads."
                    },
                    "creativeId": {
                      "type": "string",
                      "description": "The ad's id (`CR…`)."
                    },
                    "advertiserName": {
                      "description": "Who paid for the ad (Google's \"paid for by\" name), e.g. `Nike, Inc.`; it can differ from the advertiser account, e.g. for agencies. null when Google shows none, which is common (political ads, many EU ads).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "format": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "text",
                            "image",
                            "video"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "`text`, `image` or `video`. Google often saves text ads as a picture of the ad."
                    },
                    "adUrl": {
                      "type": "string",
                      "description": "The ad's page on the Ads Transparency Center."
                    },
                    "firstShown": {
                      "description": "When the ad was first shown, ISO 8601 (UTC). Google often leaves it out here; company ads always has it.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "lastShown": {
                      "description": "When the ad was last shown, ISO 8601 (UTC). Today's date for ads still running.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "daysShown": {
                      "description": "How many days the ad has been shown. A long run usually means the ad works. null when Google leaves it out.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "overallImpressions": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "min": {
                              "type": "number",
                              "description": "Lower bound of impressions."
                            },
                            "max": {
                              "type": "number",
                              "description": "Upper bound of impressions."
                            }
                          },
                          "required": [
                            "min",
                            "max"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Impressions as the range Google reports. Political ads only; null otherwise."
                    },
                    "spend": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "currency": {
                              "type": "string",
                              "description": "Currency code, e.g. USD."
                            },
                            "lower": {
                              "type": "number",
                              "description": "Lower bound of the spend, in `currency`."
                            },
                            "upper": {
                              "type": "number",
                              "description": "Upper bound of the spend, in `currency`."
                            }
                          },
                          "required": [
                            "currency",
                            "lower",
                            "upper"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Spend as the range Google reports. Political ads only; null otherwise."
                    },
                    "targeting": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "age": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  },
                                  "description": "Age groups (0-17, 18-24, 25-34, 35-44, 45-54, 55-64, 65+, unknown) the ad targeted."
                                },
                                "excluded": {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  },
                                  "description": "Age groups (0-17, 18-24, 25-34, 35-44, 45-54, 55-64, 65+, unknown) the ad excluded."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Age groups (0-17, 18-24, 25-34, 35-44, 45-54, 55-64, 65+, unknown) targeting."
                            },
                            "gender": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  },
                                  "description": "Genders (male, female, unknown) the ad targeted."
                                },
                                "excluded": {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  },
                                  "description": "Genders (male, female, unknown) the ad excluded."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Genders (male, female, unknown) targeting."
                            },
                            "location": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "criterionId": {
                                        "type": "string",
                                        "description": "Google's location id, e.g. 2840 (United States) or 1015229 (a city)."
                                      },
                                      "name": {
                                        "description": "The country's name for country-level ids; null for cities and regions, which we don't resolve.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "fullName": {
                                        "description": "Same as `name` for countries; null for cities and regions.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "countryCodes": {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        },
                                        "description": "The country code for country-level ids, e.g. [\"US\"]; empty otherwise."
                                      }
                                    },
                                    "required": [
                                      "criterionId",
                                      "name",
                                      "fullName",
                                      "countryCodes"
                                    ],
                                    "additionalProperties": false
                                  },
                                  "description": "Locations the ad targeted."
                                },
                                "excluded": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "criterionId": {
                                        "type": "string",
                                        "description": "Google's location id, e.g. 2840 (United States) or 1015229 (a city)."
                                      },
                                      "name": {
                                        "description": "The country's name for country-level ids; null for cities and regions, which we don't resolve.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "fullName": {
                                        "description": "Same as `name` for countries; null for cities and regions.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "countryCodes": {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        },
                                        "description": "The country code for country-level ids, e.g. [\"US\"]; empty otherwise."
                                      }
                                    },
                                    "required": [
                                      "criterionId",
                                      "name",
                                      "fullName",
                                      "countryCodes"
                                    ],
                                    "additionalProperties": false
                                  },
                                  "description": "Locations the ad excluded."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Location targeting."
                            }
                          },
                          "required": [
                            "age",
                            "gender",
                            "location"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Who the ad targeted. Political ads only; null otherwise. Empty lists can still mean targeting was used: Google doesn't always list the groups."
                    },
                    "targetingCategories": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "demographics": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "boolean",
                                  "description": "Whether the ad targeted people by demographic info (age, gender, language, parental status, household income)."
                                },
                                "excluded": {
                                  "type": "boolean",
                                  "description": "Whether the ad excluded people by demographic info (age, gender, language, parental status, household income)."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Targeting by demographic info (age, gender, language, parental status, household income)."
                            },
                            "locations": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "boolean",
                                  "description": "Whether the ad targeted people by geographic location."
                                },
                                "excluded": {
                                  "type": "boolean",
                                  "description": "Whether the ad excluded people by geographic location."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Targeting by geographic location."
                            },
                            "contextualSignals": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "boolean",
                                  "description": "Whether the ad targeted people by contextual signals (the pages they visit, the keywords they search)."
                                },
                                "excluded": {
                                  "type": "boolean",
                                  "description": "Whether the ad excluded people by contextual signals (the pages they visit, the keywords they search)."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Targeting by contextual signals (the pages they visit, the keywords they search)."
                            },
                            "topicsOfInterest": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "boolean",
                                  "description": "Whether the ad targeted people by topics of interest."
                                },
                                "excluded": {
                                  "type": "boolean",
                                  "description": "Whether the ad excluded people by topics of interest."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Targeting by topics of interest."
                            },
                            "customerLists": {
                              "type": "object",
                              "properties": {
                                "included": {
                                  "type": "boolean",
                                  "description": "Whether the ad targeted people by the advertiser's customer lists (data such as names and emails)."
                                },
                                "excluded": {
                                  "type": "boolean",
                                  "description": "Whether the ad excluded people by the advertiser's customer lists (data such as names and emails)."
                                }
                              },
                              "required": [
                                "included",
                                "excluded"
                              ],
                              "additionalProperties": false,
                              "description": "Targeting by the advertiser's customer lists (data such as names and emails)."
                            }
                          },
                          "required": [
                            "demographics",
                            "locations",
                            "contextualSignals",
                            "topicsOfInterest",
                            "customerLists"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Which kinds of targeting the ad used, as Google lists them for ads shown in the EU and some political ads; null when Google doesn't say."
                    },
                    "creativeRegions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "regionCode": {
                            "type": "string",
                            "description": "2-letter country code, e.g. US."
                          },
                          "regionName": {
                            "type": "string",
                            "description": "Country name in English."
                          }
                        },
                        "required": [
                          "regionCode",
                          "regionName"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Countries where the ad was shown."
                    },
                    "regionStats": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "regionCode": {
                            "type": "string",
                            "description": "2-letter country code, e.g. US."
                          },
                          "regionName": {
                            "type": "string",
                            "description": "Country name in English."
                          },
                          "firstShown": {
                            "description": "First day shown in this country, YYYY-MM-DD; often null unless the ad is political or shown in the EU.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "lastShown": {
                            "description": "Last day shown in this country, YYYY-MM-DD.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "impressions": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "min": {
                                    "type": "number",
                                    "description": "Lower bound of impressions."
                                  },
                                  "max": {
                                    "type": "number",
                                    "description": "Upper bound of impressions."
                                  }
                                },
                                "required": [
                                  "min",
                                  "max"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Impressions in this country, for political ads and ads shown in the EU; null otherwise."
                          },
                          "platformImpressions": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "platform": {
                                  "anyOf": [
                                    {
                                      "type": "string",
                                      "enum": [
                                        "google_maps",
                                        "google_play",
                                        "google_search",
                                        "google_shopping",
                                        "youtube"
                                      ]
                                    },
                                    {
                                      "type": "null"
                                    }
                                  ],
                                  "description": "The Google product."
                                },
                                "min": {
                                  "description": "Lower bound of impressions there.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "max": {
                                  "description": "Upper bound of impressions there.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "platform",
                                "min",
                                "max"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Impressions per Google product in this country, as Google reports them for ads shown in the EU; empty otherwise."
                          }
                        },
                        "required": [
                          "regionCode",
                          "regionName",
                          "firstShown",
                          "lastShown",
                          "impressions",
                          "platformImpressions"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Per-country delivery: dates and, for political ads and ads shown in the EU, impressions."
                    },
                    "eeaStats": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "firstShown": {
                              "description": "First day shown across the EEA, YYYY-MM-DD; often null unless the ad is political or shown in the EU.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "lastShown": {
                              "description": "Last day shown across the EEA, YYYY-MM-DD.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "impressions": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "min": {
                                      "type": "number",
                                      "description": "Lower bound of impressions."
                                    },
                                    "max": {
                                      "type": "number",
                                      "description": "Upper bound of impressions."
                                    }
                                  },
                                  "required": [
                                    "min",
                                    "max"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Impressions across the EEA, for political ads and ads shown in the EU; null otherwise."
                            },
                            "platformImpressions": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "platform": {
                                    "anyOf": [
                                      {
                                        "type": "string",
                                        "enum": [
                                          "google_maps",
                                          "google_play",
                                          "google_search",
                                          "google_shopping",
                                          "youtube"
                                        ]
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The Google product."
                                  },
                                  "min": {
                                    "description": "Lower bound of impressions there.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "max": {
                                    "description": "Upper bound of impressions there.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "platform",
                                  "min",
                                  "max"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Impressions per Google product across the EEA, as Google reports them for ads shown in the EU; empty otherwise."
                            }
                          },
                          "required": [
                            "firstShown",
                            "lastShown",
                            "impressions",
                            "platformImpressions"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Totals across the European Economic Area (the EU plus Iceland, Liechtenstein and Norway), which Google publishes for ads shown there; null otherwise."
                    },
                    "usStats": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "firstShown": {
                              "description": "First day shown across the US, YYYY-MM-DD; often null unless the ad is political or shown in the EU.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "lastShown": {
                              "description": "Last day shown across the US, YYYY-MM-DD.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "impressions": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "min": {
                                      "type": "number",
                                      "description": "Lower bound of impressions."
                                    },
                                    "max": {
                                      "type": "number",
                                      "description": "Upper bound of impressions."
                                    }
                                  },
                                  "required": [
                                    "min",
                                    "max"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Impressions across the US, for political ads and ads shown in the EU; null otherwise."
                            },
                            "platformImpressions": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "platform": {
                                    "anyOf": [
                                      {
                                        "type": "string",
                                        "enum": [
                                          "google_maps",
                                          "google_play",
                                          "google_search",
                                          "google_shopping",
                                          "youtube"
                                        ]
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The Google product."
                                  },
                                  "min": {
                                    "description": "Lower bound of impressions there.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "max": {
                                    "description": "Upper bound of impressions there.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "platform",
                                  "min",
                                  "max"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Impressions per Google product across the US, as Google reports them for ads shown in the EU; empty otherwise."
                            }
                          },
                          "required": [
                            "firstShown",
                            "lastShown",
                            "impressions",
                            "platformImpressions"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Totals across the United States, which Google publishes for political ads; null otherwise."
                    },
                    "variations": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "destinationUrl": {
                            "description": "Landing page, from the version's live preview. For search ads it can be just the display URL (e.g. `nike.com`); null when we didn't read one.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "headline": {
                            "description": "Headline, from the live preview; null for image-only versions and ones we didn't read.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "description": {
                            "description": "Description text, from the live preview; null for image-only versions and ones we didn't read.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "allText": {
                            "description": "All text on the ad. Always null for now, since we don't read text from images.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "imageUrl": {
                            "description": "Picture of this version; null when it only has a live preview.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "previewUrl": {
                            "description": "Google's live preview of this version (a script); null when there's an `imageUrl`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "videoId": {
                            "description": "The YouTube video id of a video ad, from the live preview (youtube.com/watch?v=<id>); null otherwise.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "destinationUrl",
                          "headline",
                          "description",
                          "allText",
                          "imageUrl",
                          "previewUrl",
                          "videoId"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every version of the ad Google shows. For text and video ads, we read the live preview of the first version that has one."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "advertiserId",
                    "creativeId",
                    "advertiserName",
                    "format",
                    "adUrl",
                    "firstShown",
                    "lastShown",
                    "daysShown",
                    "overallImpressions",
                    "spend",
                    "targeting",
                    "targetingCategories",
                    "creativeRegions",
                    "regionStats",
                    "eeaStats",
                    "usStats",
                    "variations"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/maps/search": {
      "get": {
        "operationId": "google_maps_search",
        "tags": [
          "Google"
        ],
        "summary": "Search Google Maps",
        "description": "Businesses and places matching a Google Maps search, with address, phone, website, rating, hours and coordinates.\n\nUse it to find businesses by type and area (\"dentists in Miami\") for lead lists, local SEO or market maps. Each place comes with its contact details, so you rarely need place details too.\n\nPass what you'd type into Maps as `query`. Give the area as `location` (free text, e.g. `Austin, TX`) or as `lat` and `lng`; one or the other is required.\n\n**Pagination.** 20 places per page in Google's order, up to 10 pages. Pass `next_page` as `page` for more. It's null on the last page. Later pages can repeat a few places from earlier ones.\n\nA query that names one place (`empire state building`) returns just that place.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/maps-search"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "What you'd type into Google Maps, e.g. `coffee shop` or `plumbers near me`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 300,
              "description": "What you'd type into Google Maps, e.g. `coffee shop` or `plumbers near me`."
            },
            "example": "coffee shop"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Where to search, as free text: a city, area or address, e.g. `Austin, TX`.",
            "schema": {
              "description": "Where to search, as free text: a city, area or address, e.g. `Austin, TX`.",
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "example": "Austin, TX"
          },
          {
            "name": "lat",
            "in": "query",
            "required": false,
            "description": "Latitude to center the search on, with `lng`, e.g. `30.2672`.",
            "schema": {
              "description": "Latitude to center the search on, with `lng`, e.g. `30.2672`.",
              "type": "number",
              "minimum": -90,
              "maximum": 90
            }
          },
          {
            "name": "lng",
            "in": "query",
            "required": false,
            "description": "Longitude to center the search on, with `lat`, e.g. `-97.7431`.",
            "schema": {
              "description": "Longitude to center the search on, with `lat`, e.g. `-97.7431`.",
              "type": "number",
              "minimum": -180,
              "maximum": 180
            }
          },
          {
            "name": "zoom",
            "in": "query",
            "required": false,
            "description": "How far in the map is zoomed around `lat`/`lng`, as on Maps: 10 ≈ a city, 14 ≈ a neighborhood (default), 17 ≈ a few streets.",
            "schema": {
              "description": "How far in the map is zoomed around `lat`/`lng`, as on Maps: 10 ≈ a city, 14 ≈ a neighborhood (default), 17 ≈ a few streets.",
              "default": 14,
              "type": "integer",
              "minimum": 3,
              "maximum": 21
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Page of results, 1–10; 20 places each. Use `next_page` from the previous answer.",
            "schema": {
              "description": "Page of results, 1–10; 20 places each. Use `next_page` from the previous answer.",
              "default": 1,
              "type": "integer",
              "minimum": 1,
              "maximum": 10
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Language of names, categories, hours and review text, e.g. `en`, `de`, `pt-BR`. Default `en`.",
            "schema": {
              "description": "Language of names, categories, hours and review text, e.g. `en`, `de`, `pt-BR`. Default `en`.",
              "default": "en",
              "type": "string",
              "pattern": "^[a-z]{2,3}(-[a-z]{2,4})?$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Businesses and places matching a Google Maps search, with address, phone, website, rating, hours and coordinates.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "places": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "placeId": {
                            "description": "Google's place id (`ChIJ…`), the id Google's Places API uses too. Pass it as `place_id` to place details or reviews.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "cid": {
                            "type": "string",
                            "description": "The place's cid (customer id), stable for the life of the listing: `maps.google.com/?cid=<cid>`."
                          },
                          "featureId": {
                            "type": "string",
                            "description": "Google Maps' own feature id (`0x…:0x…`), as it appears in Maps links."
                          },
                          "name": {
                            "type": "string",
                            "description": "The place's name as Google lists it."
                          },
                          "url": {
                            "type": "string",
                            "description": "The place on Google Maps."
                          },
                          "categories": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Google's categories, main one first, e.g. [\"Coffee shop\", \"Cafe\"]."
                          },
                          "address": {
                            "description": "Full street address on one line, e.g. `1300 S Congress Ave, Austin, TX 78704`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "street": {
                            "description": "Street and number.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "city": {
                            "description": "City or town.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "state": {
                            "description": "State, province or region, when the country uses one.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "postalCode": {
                            "description": "Postal code.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "countryCode": {
                            "description": "2-letter country code, e.g. US.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "neighborhood": {
                            "description": "Neighborhood or district, when Google names one.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "plusCode": {
                            "description": "The place's global plus code, e.g. `86247722+C7`. Place details only: null in search results with more than one place.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "latitude": {
                            "description": "Latitude of the place's pin.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "longitude": {
                            "description": "Longitude of the place's pin.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "phone": {
                            "description": "Phone number as written locally, e.g. `(512) 852-2300`; null when the listing has none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "phoneInternational": {
                            "description": "Phone number in E.164 form, e.g. `+15128522300`, ready to dial or match.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "website": {
                            "description": "The business's own website; null when the listing has none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "rating": {
                            "description": "Average star rating, 1–5; null with no reviews.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "reviewsCount": {
                            "description": "How many reviews Google counts; null with none.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "hours": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "day": {
                                      "type": "string",
                                      "description": "Day of the week, in `language`."
                                    },
                                    "hours": {
                                      "type": "string",
                                      "description": "Opening hours that day as Google writes them, e.g. `7 AM–7 PM`, `Open 24 hours` or `Closed`."
                                    }
                                  },
                                  "required": [
                                    "day",
                                    "hours"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Regular weekly hours, starting with the current day; null when the listing has none. Holiday hours can differ."
                          },
                          "timezone": {
                            "description": "The place's IANA timezone, e.g. America/Chicago.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "description": {
                            "description": "Google's one-line summary of the place; null for most places.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "photo": {
                            "description": "The listing's main photo, 800 px wide (edit `=w800` in the URL for another size).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "permanentlyClosed": {
                            "type": "boolean",
                            "description": "true when Google marks the place permanently closed."
                          },
                          "temporarilyClosed": {
                            "type": "boolean",
                            "description": "true when Google marks the place temporarily closed."
                          }
                        },
                        "required": [
                          "placeId",
                          "cid",
                          "featureId",
                          "name",
                          "url",
                          "categories",
                          "address",
                          "street",
                          "city",
                          "state",
                          "postalCode",
                          "countryCode",
                          "neighborhood",
                          "plusCode",
                          "latitude",
                          "longitude",
                          "phone",
                          "phoneInternational",
                          "website",
                          "rating",
                          "reviewsCount",
                          "hours",
                          "timezone",
                          "description",
                          "photo",
                          "permanentlyClosed",
                          "temporarilyClosed"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching places in Google's order."
                    },
                    "page": {
                      "type": "number",
                      "description": "This page's number."
                    },
                    "next_page": {
                      "description": "Pass as `page` for the next 20 places; null on the last page.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "places",
                    "page",
                    "next_page"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/maps/place": {
      "get": {
        "operationId": "google_maps_place",
        "tags": [
          "Google"
        ],
        "summary": "Google Maps place details",
        "description": "One place on Google Maps by place id, cid or link: contacts (phone, website, address), hours, rating, categories and coordinates.\n\nUse it to refresh or enrich a place you already know: a `placeId` or `cid` from search, an id from Google's Places API, or a Maps link.\n\nIt returns the same fields as a search result, read fresh for that one place. We don't visit the business's own website to look for emails or social links.\n\nReturns 404 `not_found` when Google has no such place.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/maps-place"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "place_id",
            "in": "query",
            "required": false,
            "description": "The place's Google place id, e.g. `ChIJ1S_Bov20RIYRe7MiR8tYawY` (`placeId` in search results). Pass this, `cid` or `url`.",
            "schema": {
              "description": "The place's Google place id, e.g. `ChIJ1S_Bov20RIYRe7MiR8tYawY` (`placeId` in search results). Pass this, `cid` or `url`.",
              "type": "string"
            },
            "example": "ChIJCar0f49ZwokR6ozLV-dHNTE"
          },
          {
            "name": "cid",
            "in": "query",
            "required": false,
            "description": "The place's cid, the number in `maps.google.com/?cid=…` (`cid` in search results).",
            "schema": {
              "description": "The place's cid, the number in `maps.google.com/?cid=…` (`cid` in search results).",
              "type": "string"
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A Google Maps link to the place: `…/maps/place/…/data=…!1s0x…:0x…`, `…?cid=…` or `…?q=place_id:ChIJ…`. Short `maps.app.goo.gl` links don't work yet.",
            "schema": {
              "description": "A Google Maps link to the place: `…/maps/place/…/data=…!1s0x…:0x…`, `…?cid=…` or `…?q=place_id:ChIJ…`. Short `maps.app.goo.gl` links don't work yet.",
              "type": "string"
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Language of names, categories, hours and review text, e.g. `en`, `de`, `pt-BR`. Default `en`.",
            "schema": {
              "description": "Language of names, categories, hours and review text, e.g. `en`, `de`, `pt-BR`. Default `en`.",
              "default": "en",
              "type": "string",
              "pattern": "^[a-z]{2,3}(-[a-z]{2,4})?$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One place on Google Maps by place id, cid or link: contacts (phone, website, address), hours, rating, categories and coordinates.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "placeId": {
                      "description": "Google's place id (`ChIJ…`), the id Google's Places API uses too. Pass it as `place_id` to place details or reviews.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "cid": {
                      "type": "string",
                      "description": "The place's cid (customer id), stable for the life of the listing: `maps.google.com/?cid=<cid>`."
                    },
                    "featureId": {
                      "type": "string",
                      "description": "Google Maps' own feature id (`0x…:0x…`), as it appears in Maps links."
                    },
                    "name": {
                      "type": "string",
                      "description": "The place's name as Google lists it."
                    },
                    "url": {
                      "type": "string",
                      "description": "The place on Google Maps."
                    },
                    "categories": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Google's categories, main one first, e.g. [\"Coffee shop\", \"Cafe\"]."
                    },
                    "address": {
                      "description": "Full street address on one line, e.g. `1300 S Congress Ave, Austin, TX 78704`.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "street": {
                      "description": "Street and number.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "city": {
                      "description": "City or town.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "state": {
                      "description": "State, province or region, when the country uses one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "postalCode": {
                      "description": "Postal code.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "countryCode": {
                      "description": "2-letter country code, e.g. US.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "neighborhood": {
                      "description": "Neighborhood or district, when Google names one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "plusCode": {
                      "description": "The place's global plus code, e.g. `86247722+C7`. Place details only: null in search results with more than one place.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "latitude": {
                      "description": "Latitude of the place's pin.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "longitude": {
                      "description": "Longitude of the place's pin.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "phone": {
                      "description": "Phone number as written locally, e.g. `(512) 852-2300`; null when the listing has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "phoneInternational": {
                      "description": "Phone number in E.164 form, e.g. `+15128522300`, ready to dial or match.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "website": {
                      "description": "The business's own website; null when the listing has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "rating": {
                      "description": "Average star rating, 1–5; null with no reviews.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "reviewsCount": {
                      "description": "How many reviews Google counts; null with none.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "hours": {
                      "anyOf": [
                        {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "day": {
                                "type": "string",
                                "description": "Day of the week, in `language`."
                              },
                              "hours": {
                                "type": "string",
                                "description": "Opening hours that day as Google writes them, e.g. `7 AM–7 PM`, `Open 24 hours` or `Closed`."
                              }
                            },
                            "required": [
                              "day",
                              "hours"
                            ],
                            "additionalProperties": false
                          }
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Regular weekly hours, starting with the current day; null when the listing has none. Holiday hours can differ."
                    },
                    "timezone": {
                      "description": "The place's IANA timezone, e.g. America/Chicago.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description": {
                      "description": "Google's one-line summary of the place; null for most places.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "photo": {
                      "description": "The listing's main photo, 800 px wide (edit `=w800` in the URL for another size).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "permanentlyClosed": {
                      "type": "boolean",
                      "description": "true when Google marks the place permanently closed."
                    },
                    "temporarilyClosed": {
                      "type": "boolean",
                      "description": "true when Google marks the place temporarily closed."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "placeId",
                    "cid",
                    "featureId",
                    "name",
                    "url",
                    "categories",
                    "address",
                    "street",
                    "city",
                    "state",
                    "postalCode",
                    "countryCode",
                    "neighborhood",
                    "plusCode",
                    "latitude",
                    "longitude",
                    "phone",
                    "phoneInternational",
                    "website",
                    "rating",
                    "reviewsCount",
                    "hours",
                    "timezone",
                    "description",
                    "photo",
                    "permanentlyClosed",
                    "temporarilyClosed"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/maps/reviews": {
      "get": {
        "operationId": "google_maps_reviews",
        "tags": [
          "Google"
        ],
        "summary": "Google Maps reviews",
        "description": "Up to 5 of a place's Google reviews in the order you pick (most relevant, newest, highest or lowest), with its rating breakdown.\n\nUse it to watch what customers say. Call it daily with `sort=newest` to catch new reviews, or use `sort=lowest` to find complaints. Pass the place as `place_id`, `cid` or `url`.\n\n**Up to 5 reviews per sort, with no further pages.** That's all Google shows signed-out visitors. Older reviews need a signed-in Google account, which we don't use. `ratingCounts` still counts every review.\n\nReturns 404 `not_found` when Google has no such place.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/maps-reviews"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "place_id",
            "in": "query",
            "required": false,
            "description": "The place's Google place id, e.g. `ChIJ1S_Bov20RIYRe7MiR8tYawY` (`placeId` in search results). Pass this, `cid` or `url`.",
            "schema": {
              "description": "The place's Google place id, e.g. `ChIJ1S_Bov20RIYRe7MiR8tYawY` (`placeId` in search results). Pass this, `cid` or `url`.",
              "type": "string"
            },
            "example": "ChIJCar0f49ZwokR6ozLV-dHNTE"
          },
          {
            "name": "cid",
            "in": "query",
            "required": false,
            "description": "The place's cid, the number in `maps.google.com/?cid=…` (`cid` in search results).",
            "schema": {
              "description": "The place's cid, the number in `maps.google.com/?cid=…` (`cid` in search results).",
              "type": "string"
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A Google Maps link to the place: `…/maps/place/…/data=…!1s0x…:0x…`, `…?cid=…` or `…?q=place_id:ChIJ…`. Short `maps.app.goo.gl` links don't work yet.",
            "schema": {
              "description": "A Google Maps link to the place: `…/maps/place/…/data=…!1s0x…:0x…`, `…?cid=…` or `…?q=place_id:ChIJ…`. Short `maps.app.goo.gl` links don't work yet.",
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Which reviews: `relevant` (Google's pick, default), `newest`, `highest` or `lowest` rated.",
            "schema": {
              "description": "Which reviews: `relevant` (Google's pick, default), `newest`, `highest` or `lowest` rated.",
              "default": "relevant",
              "type": "string",
              "enum": [
                "relevant",
                "newest",
                "highest",
                "lowest"
              ]
            },
            "example": "newest"
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Language of names, categories, hours and review text, e.g. `en`, `de`, `pt-BR`. Default `en`.",
            "schema": {
              "description": "Language of names, categories, hours and review text, e.g. `en`, `de`, `pt-BR`. Default `en`.",
              "default": "en",
              "type": "string",
              "pattern": "^[a-z]{2,3}(-[a-z]{2,4})?$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Up to 5 of a place's Google reviews in the order you pick (most relevant, newest, highest or lowest), with its rating breakdown.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "placeId": {
                      "description": "Google's place id (`ChIJ…`).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "type": "string",
                      "description": "The place's name."
                    },
                    "rating": {
                      "description": "Average star rating, 1–5; null with no reviews.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "reviewsCount": {
                      "description": "How many reviews Google counts.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "ratingCounts": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "1": {
                              "type": "number",
                              "description": "1-star reviews."
                            },
                            "2": {
                              "type": "number",
                              "description": "2-star reviews."
                            },
                            "3": {
                              "type": "number",
                              "description": "3-star reviews."
                            },
                            "4": {
                              "type": "number",
                              "description": "4-star reviews."
                            },
                            "5": {
                              "type": "number",
                              "description": "5-star reviews."
                            }
                          },
                          "required": [
                            "1",
                            "2",
                            "3",
                            "4",
                            "5"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "How many reviews gave each star rating; null when Google shows no breakdown."
                    },
                    "sort": {
                      "type": "string",
                      "enum": [
                        "relevant",
                        "newest",
                        "highest",
                        "lowest"
                      ],
                      "description": "The order these reviews are in."
                    },
                    "reviews": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "reviewId": {
                            "type": "string",
                            "description": "The review's id."
                          },
                          "url": {
                            "description": "The review on Google Maps.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "rating": {
                            "description": "Stars given, 1–5 (hotel reviews from partner sites can be fractional).",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "text": {
                            "description": "The review text as written; null for a rating without text.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "language": {
                            "description": "The language the review was written in, e.g. en.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "publishedAt": {
                            "description": "When the review was posted, ISO 8601 (UTC).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "description": "The reviewer's public name.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "id": {
                                "description": "The reviewer's Google Maps contributor id; null for a partner-site review.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "url": {
                                "description": "The reviewer's contributor page (a partner-site review links to that site).",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "photo": {
                                "description": "The reviewer's profile picture.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "reviewsCount": {
                                "description": "How many reviews the reviewer has written.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "photosCount": {
                                "description": "How many photos the reviewer has posted.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "localGuide": {
                                "type": "boolean",
                                "description": "Whether the reviewer is a Google Local Guide."
                              }
                            },
                            "required": [
                              "name",
                              "id",
                              "url",
                              "photo",
                              "reviewsCount",
                              "photosCount",
                              "localGuide"
                            ],
                            "additionalProperties": false,
                            "description": "Who wrote it."
                          },
                          "photos": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Photos attached to the review, 800 px wide."
                          },
                          "ownerResponse": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "text": {
                                    "type": "string",
                                    "description": "The owner's reply."
                                  },
                                  "publishedAt": {
                                    "description": "When the owner replied, ISO 8601 (UTC).",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "text",
                                  "publishedAt"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The business owner's reply; null when there's none."
                          }
                        },
                        "required": [
                          "reviewId",
                          "url",
                          "rating",
                          "text",
                          "language",
                          "publishedAt",
                          "author",
                          "photos",
                          "ownerResponse"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Up to 5 reviews in `sort` order. For hotels Google mixes in reviews from partner sites (e.g. TrustYou), whose `author.id` is null."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "placeId",
                    "name",
                    "rating",
                    "reviewsCount",
                    "ratingCounts",
                    "sort",
                    "reviews"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/news": {
      "get": {
        "operationId": "google_news",
        "tags": [
          "Google"
        ],
        "summary": "Search Google News",
        "description": "News articles for any search from Google News: headline, publisher and publish time, up to about 100 per call.\n\nUse it to track news coverage of a brand, person or topic. One call returns everything Google News lists for the search, up to about 100 articles, with no further pages. `date_posted` keeps only recent articles.\n\nGoogle News' search operators work in `query`: quotes, OR, `-word`, `site:reuters.com`, `intitle:`, and `before:` and `after:` with a YYYY-MM-DD date.\n\n`region` and `language` pick the Google News edition, US English by default. Leave `language` out to get the country's own edition (DE gives German). A language Google News has no edition for in that country returns a 400 error.\n\nArticles come most relevant first; sort by `published_at` for the newest. Each article links through Google News, and `google_news_url` opens it in a browser. Google encrypts the publisher's own URL inside that link, so we can't return it.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/news"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "What to search for, e.g. `nvidia` or `\"climate bill\" site:reuters.com`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 2048,
              "description": "What to search for, e.g. `nvidia` or `\"climate bill\" site:reuters.com`."
            },
            "example": "nvidia"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "The Google News edition's country: a 2-letter code (US, GB, DE, IN…).",
            "schema": {
              "description": "The Google News edition's country: a 2-letter code (US, GB, DE, IN…).",
              "default": "US",
              "type": "string",
              "pattern": "^[A-Z]{2}$"
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "The edition's language, e.g. `en`, `es` or `hi`, for countries with several (US: en, es; IN: en, hi…). Default: the country's own.",
            "schema": {
              "description": "The edition's language, e.g. `en`, `es` or `hi`, for countries with several (US: en, es; IN: en, hi…). Default: the country's own.",
              "type": "string",
              "pattern": "^[a-z]{2,3}(-[a-z0-9]{2,8})?$"
            }
          },
          {
            "name": "date_posted",
            "in": "query",
            "required": false,
            "description": "Only articles published this recently.",
            "schema": {
              "description": "Only articles published this recently.",
              "default": "any",
              "type": "string",
              "enum": [
                "any",
                "last-hour",
                "last-day",
                "last-week",
                "last-month",
                "last-year"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "News articles for any search from Google News: headline, publisher and publish time, up to about 100 per call.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "articles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "title": {
                            "type": "string",
                            "description": "The headline, without the publisher's name Google News appends."
                          },
                          "source": {
                            "description": "The publisher's name, e.g. `Reuters`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "source_url": {
                            "description": "The publisher's website, e.g. `https://www.reuters.com`.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "google_news_url": {
                            "type": "string",
                            "description": "The article's Google News link (news.google.com/rss/articles/…). It opens the article in a browser; it isn't the publisher's own URL."
                          },
                          "published_at": {
                            "description": "When it was published, ISO 8601 (UTC).",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "title",
                          "source",
                          "source_url",
                          "google_news_url",
                          "published_at"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Matching articles in Google News' order, most relevant first. Empty when nothing matches."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "articles"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/google/autocomplete": {
      "get": {
        "operationId": "google_autocomplete",
        "tags": [
          "Google"
        ],
        "summary": "Google autocomplete",
        "description": "What Google suggests as someone types: about 15 completions of a partial search, best first.\n\nUse it for keyword research (what people search around a term) or to build search-as-you-type. Pass what's typed so far as `query`. `region` and `language` pick the market, US English by default.\n\nThese are the suggestions Chrome's address bar shows. Most are searches (`type` is `query`). Some are websites (`navigation`, with the URL in `value`) or instant answers (`calculator`, e.g. `= 4` for `2+2`). An unusual query can have none.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/google/autocomplete"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "What's typed so far, e.g. `best coff`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 2048,
              "description": "What's typed so far, e.g. `best coff`."
            },
            "example": "best coff"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "Suggestions for searchers in this country: a 2-letter code (US, GB, DE…).",
            "schema": {
              "description": "Suggestions for searchers in this country: a 2-letter code (US, GB, DE…).",
              "default": "US",
              "type": "string",
              "pattern": "^[A-Z]{2}$"
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "The searchers' language, e.g. `en`, `de` or `pt-BR`.",
            "schema": {
              "description": "The searchers' language, e.g. `en`, `de` or `pt-BR`.",
              "default": "en",
              "type": "string",
              "pattern": "^[a-z]{2,3}(-[a-z0-9]{2,8})?$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "What Google suggests as someone types: about 15 completions of a partial search, best first.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "suggestions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "value": {
                            "type": "string",
                            "description": "The suggestion: a search, a URL (`navigation`) or Google's answer (`calculator`)."
                          },
                          "type": {
                            "type": "string",
                            "description": "What it is: `query` (a search), `navigation` (a website) or `calculator` (an instant answer). Others are rare."
                          },
                          "title": {
                            "description": "The page's title for `navigation`, `Calculator` for answers; null for searches.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "value",
                          "type",
                          "title"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Google's suggestions, best first: usually 15, plus an instant answer when there is one. Empty when Google has none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "suggestions"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/bluesky/profile": {
      "get": {
        "operationId": "bluesky_profile",
        "tags": [
          "Bluesky"
        ],
        "summary": "Profile",
        "description": "An account's bio, avatar, banner and exact follower, following and post counts.\n\nUse it to size up an account: exact followers, following and posts, plus bio, images and join date. `did` is the permanent id; the handle can change.\n\nAccounts that chose to hide from logged-out visitors (Bluesky's `!no-unauthenticated` label) return 403 `not_public`.\n\nUnknown, deactivated and suspended accounts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/bluesky/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Handle (e.g. `bsky.app`, with or without @), a DID (`did:plc:…`) or the profile URL. A bare name like `jay` means `jay.bsky.social`.",
            "schema": {
              "description": "Handle (e.g. `bsky.app`, with or without @), a DID (`did:plc:…`) or the profile URL. A bare name like `jay` means `jay.bsky.social`.",
              "type": "string"
            },
            "example": "bsky.app"
          }
        ],
        "responses": {
          "200": {
            "description": "An account's bio, avatar, banner and exact follower, following and post counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "did": {
                      "type": "string",
                      "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                    },
                    "handle": {
                      "type": "string",
                      "description": "Handle, e.g. `bsky.app`."
                    },
                    "displayName": {
                      "description": "Display name; null if not set.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description": {
                      "description": "Bio text; null if not set.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "description": "The profile on bsky.app."
                    },
                    "avatar": {
                      "description": "Avatar image URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "banner": {
                      "description": "Banner image URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "followersCount": {
                      "type": "number",
                      "description": "Followers, exact."
                    },
                    "followsCount": {
                      "type": "number",
                      "description": "Accounts they follow."
                    },
                    "postsCount": {
                      "type": "number",
                      "description": "Posts, replies included."
                    },
                    "createdAt": {
                      "description": "When the account was created, ISO 8601.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "pinnedPost": {
                      "description": "`at://` URI of the pinned post; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "verified": {
                      "type": "boolean",
                      "description": "Verified by Bluesky or a trusted verifier (the blue check). Trusted verifiers themselves, like `bsky.app`, are false unless also verified."
                    },
                    "trustedVerifier": {
                      "description": "A trusted verifier, which can verify other accounts (e.g. `bsky.app`). null when Bluesky doesn't report verification.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "hiddenFromLoggedOut": {
                      "type": "boolean",
                      "description": "Always false for returned profiles. Accounts hidden from logged-out visitors return 403 `not_public`."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "did",
                    "handle",
                    "displayName",
                    "description",
                    "url",
                    "avatar",
                    "banner",
                    "followersCount",
                    "followsCount",
                    "postsCount",
                    "createdAt",
                    "pinnedPost",
                    "verified",
                    "trustedVerifier",
                    "hiddenFromLoggedOut"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/bluesky/user/posts": {
      "get": {
        "operationId": "bluesky_user_posts",
        "tags": [
          "Bluesky"
        ],
        "summary": "User posts",
        "description": "An account's latest posts and reposts, newest first, with text, media and engagement counts.\n\nUse it to track what an account posts and how it lands: likes, reposts, replies and quotes on every post. The default `filter` matches the Posts tab on bsky.app: posts, reposts and the account's own threads, without replies to others, with the pinned post first (`pinned: true`). Reposts have `repost: true` and the original poster as `author`.\n\nPass `handle` or `user_id`.\n\nAccounts that chose to hide from logged-out visitors return 403 `not_public`, even when their feed is empty. Posts and reposts by other hidden accounts are left out, and quotes of their posts are null.\n\n**Pagination.** Up to 50 posts per page. Pass the response's `cursor` back as `cursor` (with the same account and filter); it's null at the end. Unknown, deactivated and suspended accounts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/bluesky/user-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Handle (e.g. `bsky.app`), a DID or the profile URL. Required unless you pass `user_id`.",
            "schema": {
              "description": "Handle (e.g. `bsky.app`), a DID or the profile URL. Required unless you pass `user_id`.",
              "type": "string"
            },
            "example": "bsky.app"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "The account's DID, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`. Required unless you pass `handle`.",
            "schema": {
              "description": "The account's DID, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`. Required unless you pass `handle`.",
              "type": "string"
            }
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "`posts_and_author_threads` (the Posts tab), `posts_with_replies`, `posts_no_replies`, `posts_with_media` or `posts_with_video`.",
            "schema": {
              "description": "`posts_and_author_threads` (the Posts tab), `posts_with_replies`, `posts_no_replies`, `posts_with_media` or `posts_with_video`.",
              "default": "posts_and_author_threads",
              "type": "string",
              "enum": [
                "posts_and_author_threads",
                "posts_with_replies",
                "posts_no_replies",
                "posts_with_media",
                "posts_with_video"
              ]
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get the next page.",
            "schema": {
              "description": "The `cursor` from the previous response, to get the next page.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An account's latest posts and reposts, newest first, with text, media and engagement counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "uri": {
                            "type": "string",
                            "description": "The post's `at://` URI, its permanent id."
                          },
                          "cid": {
                            "type": "string",
                            "description": "Content hash of this version of the post."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on bsky.app."
                          },
                          "text": {
                            "type": "string",
                            "description": "Post text, with links the app shortened (`example.com/long-pa...`) written out in full. Empty for media-only posts."
                          },
                          "createdAt": {
                            "type": "string",
                            "description": "When it was posted, ISO 8601."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "did": {
                                "type": "string",
                                "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                              },
                              "handle": {
                                "type": "string",
                                "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                              },
                              "displayName": {
                                "description": "Display name; null if not set.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatar": {
                                "description": "Avatar image URL; null if none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "did",
                              "handle",
                              "displayName",
                              "avatar"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "replyCount": {
                            "type": "number",
                            "description": "Replies."
                          },
                          "repostCount": {
                            "type": "number",
                            "description": "Reposts."
                          },
                          "likeCount": {
                            "type": "number",
                            "description": "Likes."
                          },
                          "quoteCount": {
                            "type": "number",
                            "description": "Quote posts."
                          },
                          "bookmarkCount": {
                            "type": "number",
                            "description": "Times saved to bookmarks."
                          },
                          "langs": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Languages the author tagged, e.g. `en`."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "thumbnail": {
                                  "type": "string",
                                  "description": "Small image URL."
                                },
                                "fullsize": {
                                  "type": "string",
                                  "description": "Full-size image URL."
                                },
                                "alt": {
                                  "type": "string",
                                  "description": "Alt text; empty if none."
                                }
                              },
                              "required": [
                                "thumbnail",
                                "fullsize",
                                "alt"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Attached images, in order. Empty if none."
                          },
                          "video": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "playlist": {
                                    "type": "string",
                                    "description": "HLS playlist (.m3u8) URL."
                                  },
                                  "thumbnail": {
                                    "description": "Poster image URL; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "alt": {
                                    "description": "Alt text; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "playlist",
                                  "thumbnail",
                                  "alt"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Attached video; null if none."
                          },
                          "external": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "uri": {
                                    "type": "string",
                                    "description": "The linked page."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Link card title."
                                  },
                                  "description": {
                                    "type": "string",
                                    "description": "Link card description."
                                  },
                                  "thumbnail": {
                                    "description": "Link card image URL; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "uri",
                                  "title",
                                  "description",
                                  "thumbnail"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Link card; null if none."
                          },
                          "quote": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "uri": {
                                    "type": "string",
                                    "description": "The quoted post's `at://` URI. Pass it as `url` to the post endpoint."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The quoted post on bsky.app."
                                  },
                                  "text": {
                                    "description": "Its text; null when it was deleted or its author blocks viewers.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "createdAt": {
                                    "description": "When it was posted, ISO 8601; null when unavailable.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "author": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "did": {
                                            "type": "string",
                                            "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                                          },
                                          "handle": {
                                            "type": "string",
                                            "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                                          },
                                          "displayName": {
                                            "description": "Display name; null if not set.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "avatar": {
                                            "description": "Avatar image URL; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "did",
                                          "handle",
                                          "displayName",
                                          "avatar"
                                        ],
                                        "additionalProperties": false,
                                        "description": "Who posted it."
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "Who posted it; null when unavailable."
                                  }
                                },
                                "required": [
                                  "uri",
                                  "url",
                                  "text",
                                  "createdAt",
                                  "author"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The post this one quotes; null if none or hidden from logged-out visitors. Embedded lists, feeds and starter packs aren't returned."
                          },
                          "links": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Full URLs of the links in the text."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Accounts mentioned in the text: the handle as written, without @, or the DID when the mention isn't written as @handle."
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Hashtags in the text, without #."
                          },
                          "replyTo": {
                            "description": "`at://` URI of the post this replies to; null for top-level posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "repost": {
                            "type": "boolean",
                            "description": "A repost by this account; `author` is the original poster."
                          },
                          "pinned": {
                            "type": "boolean",
                            "description": "The account's pinned post, shown first on the first page."
                          }
                        },
                        "required": [
                          "uri",
                          "cid",
                          "url",
                          "text",
                          "createdAt",
                          "author",
                          "replyCount",
                          "repostCount",
                          "likeCount",
                          "quoteCount",
                          "bookmarkCount",
                          "langs",
                          "images",
                          "video",
                          "external",
                          "quote",
                          "links",
                          "mentions",
                          "tags",
                          "replyTo",
                          "repost",
                          "pinned"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of posts, newest first (the pinned post leads the first page)."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/bluesky/post": {
      "get": {
        "operationId": "bluesky_post",
        "tags": [
          "Bluesky"
        ],
        "summary": "Post",
        "description": "A post with its replies (three levels deep) and the posts it replies to.\n\nUse it to read a conversation: the post, its replies nested under `replies`, and `parents` from the thread's first post down to the one this post answers. Replies go three levels deep; pass a reply's `uri` as `url` to read further down.\n\nSome posts are left out. Deleted posts, posts from accounts that block viewers, and posts by accounts hidden from logged-out visitors don't appear in `replies` (a hidden reply takes its branch with it). In `parents`, the chain stops below such a post. Quotes of hidden posts are null.\n\nIf the post you asked for is hidden from logged-out visitors, you get 403 `not_public`. Unknown and deleted posts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/bluesky/post"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The post's URL, e.g. `https://bsky.app/profile/bsky.app/post/3l6oveex3ii2l`, or its `at://` URI.",
            "schema": {
              "type": "string",
              "description": "The post's URL, e.g. `https://bsky.app/profile/bsky.app/post/3l6oveex3ii2l`, or its `at://` URI."
            },
            "example": "https://bsky.app/profile/bsky.app/post/3mtykea5kds2d"
          }
        ],
        "responses": {
          "200": {
            "description": "A post with its replies (three levels deep) and the posts it replies to.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "post": {
                      "type": "object",
                      "properties": {
                        "uri": {
                          "type": "string",
                          "description": "The post's `at://` URI, its permanent id."
                        },
                        "cid": {
                          "type": "string",
                          "description": "Content hash of this version of the post."
                        },
                        "url": {
                          "type": "string",
                          "description": "The post on bsky.app."
                        },
                        "text": {
                          "type": "string",
                          "description": "Post text, with links the app shortened (`example.com/long-pa...`) written out in full. Empty for media-only posts."
                        },
                        "createdAt": {
                          "type": "string",
                          "description": "When it was posted, ISO 8601."
                        },
                        "author": {
                          "type": "object",
                          "properties": {
                            "did": {
                              "type": "string",
                              "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                            },
                            "handle": {
                              "type": "string",
                              "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                            },
                            "displayName": {
                              "description": "Display name; null if not set.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "avatar": {
                              "description": "Avatar image URL; null if none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "did",
                            "handle",
                            "displayName",
                            "avatar"
                          ],
                          "additionalProperties": false,
                          "description": "Who posted it."
                        },
                        "replyCount": {
                          "type": "number",
                          "description": "Replies."
                        },
                        "repostCount": {
                          "type": "number",
                          "description": "Reposts."
                        },
                        "likeCount": {
                          "type": "number",
                          "description": "Likes."
                        },
                        "quoteCount": {
                          "type": "number",
                          "description": "Quote posts."
                        },
                        "bookmarkCount": {
                          "type": "number",
                          "description": "Times saved to bookmarks."
                        },
                        "langs": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Languages the author tagged, e.g. `en`."
                        },
                        "images": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "thumbnail": {
                                "type": "string",
                                "description": "Small image URL."
                              },
                              "fullsize": {
                                "type": "string",
                                "description": "Full-size image URL."
                              },
                              "alt": {
                                "type": "string",
                                "description": "Alt text; empty if none."
                              }
                            },
                            "required": [
                              "thumbnail",
                              "fullsize",
                              "alt"
                            ],
                            "additionalProperties": false
                          },
                          "description": "Attached images, in order. Empty if none."
                        },
                        "video": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "playlist": {
                                  "type": "string",
                                  "description": "HLS playlist (.m3u8) URL."
                                },
                                "thumbnail": {
                                  "description": "Poster image URL; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "alt": {
                                  "description": "Alt text; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "playlist",
                                "thumbnail",
                                "alt"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Attached video; null if none."
                        },
                        "external": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "uri": {
                                  "type": "string",
                                  "description": "The linked page."
                                },
                                "title": {
                                  "type": "string",
                                  "description": "Link card title."
                                },
                                "description": {
                                  "type": "string",
                                  "description": "Link card description."
                                },
                                "thumbnail": {
                                  "description": "Link card image URL; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "uri",
                                "title",
                                "description",
                                "thumbnail"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Link card; null if none."
                        },
                        "quote": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "uri": {
                                  "type": "string",
                                  "description": "The quoted post's `at://` URI. Pass it as `url` to the post endpoint."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "The quoted post on bsky.app."
                                },
                                "text": {
                                  "description": "Its text; null when it was deleted or its author blocks viewers.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "createdAt": {
                                  "description": "When it was posted, ISO 8601; null when unavailable.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "author": {
                                  "anyOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "did": {
                                          "type": "string",
                                          "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                                        },
                                        "handle": {
                                          "type": "string",
                                          "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                                        },
                                        "displayName": {
                                          "description": "Display name; null if not set.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "avatar": {
                                          "description": "Avatar image URL; null if none.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "did",
                                        "handle",
                                        "displayName",
                                        "avatar"
                                      ],
                                      "additionalProperties": false,
                                      "description": "Who posted it."
                                    },
                                    {
                                      "type": "null"
                                    }
                                  ],
                                  "description": "Who posted it; null when unavailable."
                                }
                              },
                              "required": [
                                "uri",
                                "url",
                                "text",
                                "createdAt",
                                "author"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The post this one quotes; null if none or hidden from logged-out visitors. Embedded lists, feeds and starter packs aren't returned."
                        },
                        "links": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Full URLs of the links in the text."
                        },
                        "mentions": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Accounts mentioned in the text: the handle as written, without @, or the DID when the mention isn't written as @handle."
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Hashtags in the text, without #."
                        },
                        "replyTo": {
                          "description": "`at://` URI of the post this replies to; null for top-level posts.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "uri",
                        "cid",
                        "url",
                        "text",
                        "createdAt",
                        "author",
                        "replyCount",
                        "repostCount",
                        "likeCount",
                        "quoteCount",
                        "bookmarkCount",
                        "langs",
                        "images",
                        "video",
                        "external",
                        "quote",
                        "links",
                        "mentions",
                        "tags",
                        "replyTo"
                      ],
                      "additionalProperties": false,
                      "description": "The post."
                    },
                    "replies": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/BlueskyReply"
                      },
                      "description": "Replies in Bluesky's order, each with its own replies."
                    },
                    "parents": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "uri": {
                            "type": "string",
                            "description": "The post's `at://` URI, its permanent id."
                          },
                          "cid": {
                            "type": "string",
                            "description": "Content hash of this version of the post."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on bsky.app."
                          },
                          "text": {
                            "type": "string",
                            "description": "Post text, with links the app shortened (`example.com/long-pa...`) written out in full. Empty for media-only posts."
                          },
                          "createdAt": {
                            "type": "string",
                            "description": "When it was posted, ISO 8601."
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "did": {
                                "type": "string",
                                "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                              },
                              "handle": {
                                "type": "string",
                                "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                              },
                              "displayName": {
                                "description": "Display name; null if not set.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "avatar": {
                                "description": "Avatar image URL; null if none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "did",
                              "handle",
                              "displayName",
                              "avatar"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "replyCount": {
                            "type": "number",
                            "description": "Replies."
                          },
                          "repostCount": {
                            "type": "number",
                            "description": "Reposts."
                          },
                          "likeCount": {
                            "type": "number",
                            "description": "Likes."
                          },
                          "quoteCount": {
                            "type": "number",
                            "description": "Quote posts."
                          },
                          "bookmarkCount": {
                            "type": "number",
                            "description": "Times saved to bookmarks."
                          },
                          "langs": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Languages the author tagged, e.g. `en`."
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "thumbnail": {
                                  "type": "string",
                                  "description": "Small image URL."
                                },
                                "fullsize": {
                                  "type": "string",
                                  "description": "Full-size image URL."
                                },
                                "alt": {
                                  "type": "string",
                                  "description": "Alt text; empty if none."
                                }
                              },
                              "required": [
                                "thumbnail",
                                "fullsize",
                                "alt"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Attached images, in order. Empty if none."
                          },
                          "video": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "playlist": {
                                    "type": "string",
                                    "description": "HLS playlist (.m3u8) URL."
                                  },
                                  "thumbnail": {
                                    "description": "Poster image URL; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "alt": {
                                    "description": "Alt text; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "playlist",
                                  "thumbnail",
                                  "alt"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Attached video; null if none."
                          },
                          "external": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "uri": {
                                    "type": "string",
                                    "description": "The linked page."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "Link card title."
                                  },
                                  "description": {
                                    "type": "string",
                                    "description": "Link card description."
                                  },
                                  "thumbnail": {
                                    "description": "Link card image URL; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "uri",
                                  "title",
                                  "description",
                                  "thumbnail"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Link card; null if none."
                          },
                          "quote": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "uri": {
                                    "type": "string",
                                    "description": "The quoted post's `at://` URI. Pass it as `url` to the post endpoint."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The quoted post on bsky.app."
                                  },
                                  "text": {
                                    "description": "Its text; null when it was deleted or its author blocks viewers.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "createdAt": {
                                    "description": "When it was posted, ISO 8601; null when unavailable.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "author": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "did": {
                                            "type": "string",
                                            "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                                          },
                                          "handle": {
                                            "type": "string",
                                            "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                                          },
                                          "displayName": {
                                            "description": "Display name; null if not set.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "avatar": {
                                            "description": "Avatar image URL; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "did",
                                          "handle",
                                          "displayName",
                                          "avatar"
                                        ],
                                        "additionalProperties": false,
                                        "description": "Who posted it."
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "Who posted it; null when unavailable."
                                  }
                                },
                                "required": [
                                  "uri",
                                  "url",
                                  "text",
                                  "createdAt",
                                  "author"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The post this one quotes; null if none or hidden from logged-out visitors. Embedded lists, feeds and starter packs aren't returned."
                          },
                          "links": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Full URLs of the links in the text."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Accounts mentioned in the text: the handle as written, without @, or the DID when the mention isn't written as @handle."
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Hashtags in the text, without #."
                          },
                          "replyTo": {
                            "description": "`at://` URI of the post this replies to; null for top-level posts.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "uri",
                          "cid",
                          "url",
                          "text",
                          "createdAt",
                          "author",
                          "replyCount",
                          "repostCount",
                          "likeCount",
                          "quoteCount",
                          "bookmarkCount",
                          "langs",
                          "images",
                          "video",
                          "external",
                          "quote",
                          "links",
                          "mentions",
                          "tags",
                          "replyTo"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The posts above this one in the thread, first post first. Empty for top-level posts."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "post",
                    "replies",
                    "parents"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/snapchat/profile": {
      "get": {
        "operationId": "snapchat_profile",
        "tags": [
          "Snapchat"
        ],
        "summary": "Profile and stories",
        "description": "A public profile with its live story, highlights and Spotlight videos, with direct media links.\n\nUse it to see what a creator or brand is posting on Snapchat right now, without an account. One call returns the profile, the live public story (`story`), saved highlights and up to ~25 recent Spotlight videos.\n\n**Only Public Profiles post to the web.** For a regular account you get the username, display name and Snapcode, `isPublic: false` and empty lists. That's not an error. Friends-only and private stories are never visible.\n\n**Media links** point straight at Snapchat's CDN and open without cookies. Story snaps are temporary (usually 24 hours; some creators keep theirs up for several days), so save what you need.\n\nUnknown usernames return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/snapchat/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Snapchat username, with or without @ (e.g. `nba`), or the profile URL (`snapchat.com/add/nba`, `snapchat.com/@nba`).",
            "schema": {
              "description": "Snapchat username, with or without @ (e.g. `nba`), or the profile URL (`snapchat.com/add/nba`, `snapchat.com/@nba`).",
              "type": "string"
            },
            "example": "nba"
          }
        ],
        "responses": {
          "200": {
            "description": "A public profile with its live story, highlights and Spotlight videos, with direct media links.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "profile": {
                      "type": "object",
                      "properties": {
                        "username": {
                          "type": "string",
                          "description": "Username, lowercase."
                        },
                        "displayName": {
                          "description": "Display name.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "bio": {
                          "description": "Bio; null if empty or not public.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "subscriberCount": {
                          "description": "Followers, as Snapchat gives them (in steps of 100). The field keeps its old name from when Snapchat called them subscribers. null when the creator hides it or the account isn't public.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "website": {
                          "description": "Website link from the profile, with `https://` added when the creator left it out.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "avatarUrl": {
                          "description": "Profile picture.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "snapcodeUrl": {
                          "description": "The account's Snapcode (SVG), scannable to add them.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "category": {
                          "description": "Profile category, e.g. `people` or `business-group`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "subcategory": {
                          "description": "Profile subcategory, e.g. `artist` or `sports-league`.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "badge": {
                          "anyOf": [
                            {
                              "type": "string",
                              "enum": [
                                "star",
                                "tick",
                                "snapchat_plus"
                              ]
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Badge next to the name: `star` (Snap Star), `tick` (verified checkmark) or `snapchat_plus`; null without one."
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has a Snap Star or checkmark badge."
                        },
                        "isPublic": {
                          "type": "boolean",
                          "description": "Has a Public Profile. Only public profiles show stories, highlights and Spotlight on the web; for other accounts the lists are empty."
                        },
                        "hasStory": {
                          "type": "boolean",
                          "description": "A public story is live right now (`story` isn't empty)."
                        },
                        "createdAt": {
                          "description": "When the Public Profile was created; null if not public, ISO 8601.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "url": {
                          "type": "string",
                          "description": "Profile on snapchat.com."
                        }
                      },
                      "required": [
                        "username",
                        "displayName",
                        "bio",
                        "subscriberCount",
                        "website",
                        "avatarUrl",
                        "snapcodeUrl",
                        "category",
                        "subcategory",
                        "badge",
                        "verified",
                        "isPublic",
                        "hasStory",
                        "createdAt",
                        "url"
                      ],
                      "additionalProperties": false,
                      "description": "The account."
                    },
                    "story": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "description": "Snap id. null in highlights, where Snapchat serves snaps without one.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "image",
                              "video"
                            ],
                            "description": "`image` or `video`."
                          },
                          "thumbnailUrl": {
                            "description": "Small preview image on Snapchat's CDN.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "mediaUrl": {
                            "type": "string",
                            "description": "The full image or video on Snapchat's CDN. Opens in a browser as is, with no login or cookies."
                          },
                          "postedAt": {
                            "description": "When it was posted, ISO 8601.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "type",
                          "thumbnailUrl",
                          "mediaUrl",
                          "postedAt"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The public story that's live now, oldest snap first. Empty when there's none."
                    },
                    "highlights": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "description": "Highlight id.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "title": {
                            "description": "The highlight's title, as the creator named it.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnailUrl": {
                            "description": "Cover image.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "snaps": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "description": "Snap id. null in highlights, where Snapchat serves snaps without one.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "type": {
                                  "type": "string",
                                  "enum": [
                                    "image",
                                    "video"
                                  ],
                                  "description": "`image` or `video`."
                                },
                                "thumbnailUrl": {
                                  "description": "Small preview image on Snapchat's CDN.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "mediaUrl": {
                                  "type": "string",
                                  "description": "The full image or video on Snapchat's CDN. Opens in a browser as is, with no login or cookies."
                                },
                                "postedAt": {
                                  "description": "When it was posted, ISO 8601.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "id",
                                "type",
                                "thumbnailUrl",
                                "mediaUrl",
                                "postedAt"
                              ],
                              "additionalProperties": false
                            },
                            "description": "The snaps saved in this highlight, in order."
                          }
                        },
                        "required": [
                          "id",
                          "title",
                          "thumbnailUrl",
                          "snaps"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Saved story highlights, as ordered on the profile."
                    },
                    "spotlight": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Spotlight id."
                          },
                          "url": {
                            "type": "string",
                            "description": "The Spotlight's page on snapchat.com."
                          },
                          "title": {
                            "description": "The creator's title or on-screen caption. When there's none, Snapchat's own AI-generated title; null if neither exists.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "description": {
                            "description": "The creator's description, hashtags included; null if empty.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnailUrl": {
                            "description": "Cover image.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "videoUrl": {
                            "type": "string",
                            "description": "The video on Snapchat's CDN. Opens in a browser as is."
                          },
                          "durationMs": {
                            "description": "Length in milliseconds.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "views": {
                            "description": "View count; null if hidden.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "shares": {
                            "description": "Share count; null if Snapchat didn't include it.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "comments": {
                            "description": "Comment count; null if Snapchat didn't include it.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "postedAt": {
                            "description": "When it was posted, ISO 8601.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Hashtags as Snapchat lists them, often lowercased, e.g. `#nba`."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "title",
                          "description",
                          "thumbnailUrl",
                          "videoUrl",
                          "durationMs",
                          "views",
                          "shares",
                          "comments",
                          "postedAt",
                          "hashtags"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Recent Spotlight videos (up to ~25), newest first."
                    },
                    "relatedAccounts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "username": {
                            "type": "string",
                            "description": "Username."
                          },
                          "displayName": {
                            "description": "Display name.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "avatarUrl": {
                            "description": "Profile picture.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "verified": {
                            "type": "boolean",
                            "description": "Has a Snap Star or checkmark badge."
                          },
                          "url": {
                            "type": "string",
                            "description": "Profile on snapchat.com."
                          }
                        },
                        "required": [
                          "username",
                          "displayName",
                          "avatarUrl",
                          "verified",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Accounts Snapchat suggests alongside this one."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "profile",
                    "story",
                    "highlights",
                    "spotlight",
                    "relatedAccounts"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/truthsocial/profile": {
      "get": {
        "operationId": "truthsocial_profile",
        "tags": [
          "Truth Social"
        ],
        "summary": "Profile",
        "description": "An account's bio, avatar, follower and post counts, and verification.\n\nUse it to size up an account: followers, following, post count, verification and the date of the latest post. `id` is what user posts takes as `user_id`.\n\nPass `handle` as a username, `@username` or a truthsocial.com profile URL.\n\nUnknown accounts return 404 `not_found`. Accounts hidden from logged-out visitors return 403 `not_public`. When Truth Social doesn't say whether an account is hidden or missing, you get 404 `not_found`. Prominent accounts and most other public ones are visible.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/truthsocial/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Username, with or without @ (e.g. `realDonaldTrump`), or the profile URL.",
            "schema": {
              "description": "Username, with or without @ (e.g. `realDonaldTrump`), or the profile URL.",
              "type": "string"
            },
            "example": "realDonaldTrump"
          }
        ],
        "responses": {
          "200": {
            "description": "An account's bio, avatar, follower and post counts, and verification.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Account id, e.g. `107780257626128497`. Pass it as `user_id` to user posts."
                    },
                    "username": {
                      "type": "string",
                      "description": "Username without @, e.g. `realDonaldTrump`."
                    },
                    "acct": {
                      "type": "string",
                      "description": "Same as username: every Truth Social account is local."
                    },
                    "display_name": {
                      "type": "string",
                      "description": "Display name."
                    },
                    "note": {
                      "type": "string",
                      "description": "Bio as HTML."
                    },
                    "note_text": {
                      "type": "string",
                      "description": "Bio as plain text."
                    },
                    "url": {
                      "type": "string",
                      "description": "Profile on truthsocial.com."
                    },
                    "avatar": {
                      "description": "Profile picture URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "header": {
                      "description": "Banner image URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "website": {
                      "description": "Website from the profile, as typed (may lack https://); null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "location": {
                      "description": "Location from the profile; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "fields": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Label."
                          },
                          "value": {
                            "type": "string",
                            "description": "Value as HTML."
                          }
                        },
                        "required": [
                          "name",
                          "value"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Extra profile fields (label/value pairs)."
                    },
                    "followers_count": {
                      "type": "number",
                      "description": "Followers."
                    },
                    "following_count": {
                      "type": "number",
                      "description": "Accounts followed."
                    },
                    "statuses_count": {
                      "type": "number",
                      "description": "Posts, replies and reposts."
                    },
                    "last_status_at": {
                      "description": "Day of the latest post, `YYYY-MM-DD`; null if never posted.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "verified": {
                      "type": "boolean",
                      "description": "Has the verified badge."
                    },
                    "premium": {
                      "description": "Has Truth+ premium; null if not reported.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "locked": {
                      "type": "boolean",
                      "description": "Approves followers manually."
                    },
                    "bot": {
                      "type": "boolean",
                      "description": "Marked as an automated account."
                    },
                    "created_at": {
                      "type": "string",
                      "description": "Account created at, ISO 8601."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "username",
                    "acct",
                    "display_name",
                    "note",
                    "note_text",
                    "url",
                    "avatar",
                    "header",
                    "website",
                    "location",
                    "fields",
                    "followers_count",
                    "following_count",
                    "statuses_count",
                    "last_status_at",
                    "verified",
                    "premium",
                    "locked",
                    "bot",
                    "created_at"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/truthsocial/user/posts": {
      "get": {
        "operationId": "truthsocial_user_posts",
        "tags": [
          "Truth Social"
        ],
        "summary": "User posts",
        "description": "An account's latest posts and ReTruths, newest first, 20 per page.\n\nUse it to monitor an account: every post with text, media, link previews and reply, ReTruth and like counts. Replies are left out; ReTruths are included, with the original post in `reblog`.\n\nPass `handle` or `user_id` (from profile). `user_id` skips a lookup, but both cost the same.\n\n**Pagination.** Pass the response's `next_max_id` back as `next_max_id` (with the same account) for older posts. It's null once a page comes back empty.\n\nUnknown accounts return 404 `not_found`. Accounts hidden from logged-out visitors return 403 `not_public`. When Truth Social doesn't say whether an account is hidden or missing, you get 404 `not_found`. Prominent accounts and most other public ones are visible.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/truthsocial/user-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Username (e.g. `realDonaldTrump`), `@username` or profile URL. Required unless you pass `user_id`.",
            "schema": {
              "description": "Username (e.g. `realDonaldTrump`), `@username` or profile URL. Required unless you pass `user_id`.",
              "type": "string"
            },
            "example": "realDonaldTrump"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Numeric account id from profile, e.g. `107780257626128497`. Used instead of `handle` when both are given.",
            "schema": {
              "description": "Numeric account id from profile, e.g. `107780257626128497`. Used instead of `handle` when both are given.",
              "type": "string"
            }
          },
          {
            "name": "next_max_id",
            "in": "query",
            "required": false,
            "description": "The `next_max_id` from the previous response, to get older posts.",
            "schema": {
              "description": "The `next_max_id` from the previous response, to get older posts.",
              "type": "string",
              "pattern": "^\\d{1,20}$"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "`true` omits each post's HTML `content` (plain `text` stays) for a smaller response.",
            "schema": {
              "description": "`true` omits each post's HTML `content` (plain `text` stays) for a smaller response.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An account's latest posts and ReTruths, newest first, 20 per page.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Post id, e.g. `117351985093810875`."
                          },
                          "created_at": {
                            "type": "string",
                            "description": "Posted at, ISO 8601."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on truthsocial.com."
                          },
                          "content": {
                            "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                            "type": "string"
                          },
                          "text": {
                            "type": "string",
                            "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                          },
                          "title": {
                            "description": "Title, on group posts that have one; else null.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "language": {
                            "description": "Language code (e.g. `en`) when detected; often null.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "visibility": {
                            "type": "string",
                            "description": "`public`, or `group` for posts in a group."
                          },
                          "sensitive": {
                            "type": "boolean",
                            "description": "Marked sensitive (media hidden behind a warning)."
                          },
                          "spoiler_text": {
                            "type": "string",
                            "description": "Content warning; empty if none."
                          },
                          "in_reply_to_id": {
                            "description": "The post this replies to; null if not a reply.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "in_reply_to_account_id": {
                            "description": "Author of the post this replies to.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "quote_id": {
                            "description": "The quoted post's id; null if not a quote.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "replies_count": {
                            "type": "number",
                            "description": "Replies."
                          },
                          "reblogs_count": {
                            "type": "number",
                            "description": "ReTruths (reposts)."
                          },
                          "favourites_count": {
                            "type": "number",
                            "description": "Likes."
                          },
                          "upvotes_count": {
                            "description": "Upvotes (Truth Social's likes); null if not reported.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "downvotes_count": {
                            "description": "Downvotes; null if not reported.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "edited_at": {
                            "description": "Last edit, ISO 8601; null if never edited.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "media_attachments": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "description": "Attachment id."
                                },
                                "type": {
                                  "type": "string",
                                  "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                },
                                "url": {
                                  "description": "The file (full-size image or MP4).",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "preview_url": {
                                  "description": "A smaller image, or the video's thumbnail.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "description": {
                                  "description": "Alt text; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "meta": {
                                  "type": "object",
                                  "properties": {
                                    "original": {
                                      "anyOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "width": {
                                              "description": "Width in pixels.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            },
                                            "height": {
                                              "description": "Height in pixels.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            },
                                            "aspect": {
                                              "description": "Width / height; null when not reported (videos).",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            },
                                            "duration": {
                                              "description": "Length in seconds, for video and audio; else null.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "width",
                                            "height",
                                            "aspect",
                                            "duration"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "null"
                                        }
                                      ],
                                      "description": "Size of the file at `url`."
                                    },
                                    "small": {
                                      "anyOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "width": {
                                              "description": "Width in pixels.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            },
                                            "height": {
                                              "description": "Height in pixels.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            },
                                            "aspect": {
                                              "description": "Width / height; null when not reported (videos).",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            },
                                            "duration": {
                                              "description": "Length in seconds, for video and audio; else null.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "width",
                                            "height",
                                            "aspect",
                                            "duration"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "null"
                                        }
                                      ],
                                      "description": "Size of the image at `preview_url`."
                                    }
                                  },
                                  "required": [
                                    "original",
                                    "small"
                                  ],
                                  "additionalProperties": false,
                                  "description": "Sizes, as Mastodon reports them."
                                }
                              },
                              "required": [
                                "id",
                                "type",
                                "url",
                                "preview_url",
                                "description",
                                "meta"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Images and videos, in order."
                          },
                          "card": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "type": "string",
                                    "description": "The linked page."
                                  },
                                  "title": {
                                    "description": "Page title.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "description": {
                                    "description": "Page description.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "type": {
                                    "description": "`link`, `video`, `photo` or `rich`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "provider_name": {
                                    "description": "Site name, e.g. `x.com`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "image": {
                                    "description": "Preview image URL (hosted by Truth Social).",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "url",
                                  "title",
                                  "description",
                                  "type",
                                  "provider_name",
                                  "image"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Link preview for the first link in the post; null if none."
                          },
                          "group": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Group id."
                                  },
                                  "display_name": {
                                    "type": "string",
                                    "description": "Group name."
                                  },
                                  "slug": {
                                    "description": "URL name, e.g. `republicans`.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "url": {
                                    "description": "Group on truthsocial.com.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "members_count": {
                                    "description": "Members.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "display_name",
                                  "slug",
                                  "url",
                                  "members_count"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The group it was posted in; null for ordinary posts."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "description": "Account id."
                                },
                                "username": {
                                  "type": "string",
                                  "description": "Username without @."
                                },
                                "acct": {
                                  "type": "string",
                                  "description": "Same as username."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "Profile on truthsocial.com."
                                }
                              },
                              "required": [
                                "id",
                                "username",
                                "acct",
                                "url"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Accounts mentioned; quote posts also list the quoted post's author."
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string",
                                  "description": "Hashtag without #."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "Hashtag page on truthsocial.com."
                                }
                              },
                              "required": [
                                "name",
                                "url"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Hashtags used."
                          },
                          "account": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Account id."
                              },
                              "username": {
                                "type": "string",
                                "description": "Username without @."
                              },
                              "acct": {
                                "type": "string",
                                "description": "Same as username."
                              },
                              "display_name": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "url": {
                                "type": "string",
                                "description": "Profile on truthsocial.com."
                              },
                              "avatar": {
                                "description": "Profile picture URL; null if none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the verified badge."
                              },
                              "followers_count": {
                                "type": "number",
                                "description": "Followers."
                              }
                            },
                            "required": [
                              "id",
                              "username",
                              "acct",
                              "display_name",
                              "url",
                              "avatar",
                              "verified",
                              "followers_count"
                            ],
                            "additionalProperties": false,
                            "description": "The author."
                          },
                          "reblog": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Post id, e.g. `117351985093810875`."
                                  },
                                  "created_at": {
                                    "type": "string",
                                    "description": "Posted at, ISO 8601."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The post on truthsocial.com."
                                  },
                                  "content": {
                                    "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                                    "type": "string"
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                                  },
                                  "title": {
                                    "description": "Title, on group posts that have one; else null.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "language": {
                                    "description": "Language code (e.g. `en`) when detected; often null.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "visibility": {
                                    "type": "string",
                                    "description": "`public`, or `group` for posts in a group."
                                  },
                                  "sensitive": {
                                    "type": "boolean",
                                    "description": "Marked sensitive (media hidden behind a warning)."
                                  },
                                  "spoiler_text": {
                                    "type": "string",
                                    "description": "Content warning; empty if none."
                                  },
                                  "in_reply_to_id": {
                                    "description": "The post this replies to; null if not a reply.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "in_reply_to_account_id": {
                                    "description": "Author of the post this replies to.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "quote_id": {
                                    "description": "The quoted post's id; null if not a quote.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "replies_count": {
                                    "type": "number",
                                    "description": "Replies."
                                  },
                                  "reblogs_count": {
                                    "type": "number",
                                    "description": "ReTruths (reposts)."
                                  },
                                  "favourites_count": {
                                    "type": "number",
                                    "description": "Likes."
                                  },
                                  "upvotes_count": {
                                    "description": "Upvotes (Truth Social's likes); null if not reported.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "downvotes_count": {
                                    "description": "Downvotes; null if not reported.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "edited_at": {
                                    "description": "Last edit, ISO 8601; null if never edited.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "media_attachments": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "type": "string",
                                          "description": "Attachment id."
                                        },
                                        "type": {
                                          "type": "string",
                                          "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                        },
                                        "url": {
                                          "description": "The file (full-size image or MP4).",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "preview_url": {
                                          "description": "A smaller image, or the video's thumbnail.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "description": {
                                          "description": "Alt text; null if none.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "meta": {
                                          "type": "object",
                                          "properties": {
                                            "original": {
                                              "anyOf": [
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "width": {
                                                      "description": "Width in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "height": {
                                                      "description": "Height in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "aspect": {
                                                      "description": "Width / height; null when not reported (videos).",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "duration": {
                                                      "description": "Length in seconds, for video and audio; else null.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    }
                                                  },
                                                  "required": [
                                                    "width",
                                                    "height",
                                                    "aspect",
                                                    "duration"
                                                  ],
                                                  "additionalProperties": false
                                                },
                                                {
                                                  "type": "null"
                                                }
                                              ],
                                              "description": "Size of the file at `url`."
                                            },
                                            "small": {
                                              "anyOf": [
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "width": {
                                                      "description": "Width in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "height": {
                                                      "description": "Height in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "aspect": {
                                                      "description": "Width / height; null when not reported (videos).",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "duration": {
                                                      "description": "Length in seconds, for video and audio; else null.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    }
                                                  },
                                                  "required": [
                                                    "width",
                                                    "height",
                                                    "aspect",
                                                    "duration"
                                                  ],
                                                  "additionalProperties": false
                                                },
                                                {
                                                  "type": "null"
                                                }
                                              ],
                                              "description": "Size of the image at `preview_url`."
                                            }
                                          },
                                          "required": [
                                            "original",
                                            "small"
                                          ],
                                          "additionalProperties": false,
                                          "description": "Sizes, as Mastodon reports them."
                                        }
                                      },
                                      "required": [
                                        "id",
                                        "type",
                                        "url",
                                        "preview_url",
                                        "description",
                                        "meta"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Images and videos, in order."
                                  },
                                  "card": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "url": {
                                            "type": "string",
                                            "description": "The linked page."
                                          },
                                          "title": {
                                            "description": "Page title.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "description": {
                                            "description": "Page description.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "type": {
                                            "description": "`link`, `video`, `photo` or `rich`.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "provider_name": {
                                            "description": "Site name, e.g. `x.com`.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "image": {
                                            "description": "Preview image URL (hosted by Truth Social).",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "url",
                                          "title",
                                          "description",
                                          "type",
                                          "provider_name",
                                          "image"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "Link preview for the first link in the post; null if none."
                                  },
                                  "group": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "type": "string",
                                            "description": "Group id."
                                          },
                                          "display_name": {
                                            "type": "string",
                                            "description": "Group name."
                                          },
                                          "slug": {
                                            "description": "URL name, e.g. `republicans`.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "url": {
                                            "description": "Group on truthsocial.com.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "members_count": {
                                            "description": "Members.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "display_name",
                                          "slug",
                                          "url",
                                          "members_count"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The group it was posted in; null for ordinary posts."
                                  },
                                  "mentions": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "type": "string",
                                          "description": "Account id."
                                        },
                                        "username": {
                                          "type": "string",
                                          "description": "Username without @."
                                        },
                                        "acct": {
                                          "type": "string",
                                          "description": "Same as username."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "Profile on truthsocial.com."
                                        }
                                      },
                                      "required": [
                                        "id",
                                        "username",
                                        "acct",
                                        "url"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Accounts mentioned; quote posts also list the quoted post's author."
                                  },
                                  "tags": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "name": {
                                          "type": "string",
                                          "description": "Hashtag without #."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "Hashtag page on truthsocial.com."
                                        }
                                      },
                                      "required": [
                                        "name",
                                        "url"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Hashtags used."
                                  },
                                  "account": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "string",
                                        "description": "Account id."
                                      },
                                      "username": {
                                        "type": "string",
                                        "description": "Username without @."
                                      },
                                      "acct": {
                                        "type": "string",
                                        "description": "Same as username."
                                      },
                                      "display_name": {
                                        "type": "string",
                                        "description": "Display name."
                                      },
                                      "url": {
                                        "type": "string",
                                        "description": "Profile on truthsocial.com."
                                      },
                                      "avatar": {
                                        "description": "Profile picture URL; null if none.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "verified": {
                                        "type": "boolean",
                                        "description": "Has the verified badge."
                                      },
                                      "followers_count": {
                                        "type": "number",
                                        "description": "Followers."
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "username",
                                      "acct",
                                      "display_name",
                                      "url",
                                      "avatar",
                                      "verified",
                                      "followers_count"
                                    ],
                                    "additionalProperties": false,
                                    "description": "The author."
                                  },
                                  "quote": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "type": "string",
                                            "description": "Post id, e.g. `117351985093810875`."
                                          },
                                          "created_at": {
                                            "type": "string",
                                            "description": "Posted at, ISO 8601."
                                          },
                                          "url": {
                                            "type": "string",
                                            "description": "The post on truthsocial.com."
                                          },
                                          "content": {
                                            "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string",
                                            "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                                          },
                                          "title": {
                                            "description": "Title, on group posts that have one; else null.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "language": {
                                            "description": "Language code (e.g. `en`) when detected; often null.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "visibility": {
                                            "type": "string",
                                            "description": "`public`, or `group` for posts in a group."
                                          },
                                          "sensitive": {
                                            "type": "boolean",
                                            "description": "Marked sensitive (media hidden behind a warning)."
                                          },
                                          "spoiler_text": {
                                            "type": "string",
                                            "description": "Content warning; empty if none."
                                          },
                                          "in_reply_to_id": {
                                            "description": "The post this replies to; null if not a reply.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "in_reply_to_account_id": {
                                            "description": "Author of the post this replies to.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "quote_id": {
                                            "description": "The quoted post's id; null if not a quote.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "replies_count": {
                                            "type": "number",
                                            "description": "Replies."
                                          },
                                          "reblogs_count": {
                                            "type": "number",
                                            "description": "ReTruths (reposts)."
                                          },
                                          "favourites_count": {
                                            "type": "number",
                                            "description": "Likes."
                                          },
                                          "upvotes_count": {
                                            "description": "Upvotes (Truth Social's likes); null if not reported.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          },
                                          "downvotes_count": {
                                            "description": "Downvotes; null if not reported.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          },
                                          "edited_at": {
                                            "description": "Last edit, ISO 8601; null if never edited.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "media_attachments": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "properties": {
                                                "id": {
                                                  "type": "string",
                                                  "description": "Attachment id."
                                                },
                                                "type": {
                                                  "type": "string",
                                                  "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                                },
                                                "url": {
                                                  "description": "The file (full-size image or MP4).",
                                                  "type": [
                                                    "string",
                                                    "null"
                                                  ]
                                                },
                                                "preview_url": {
                                                  "description": "A smaller image, or the video's thumbnail.",
                                                  "type": [
                                                    "string",
                                                    "null"
                                                  ]
                                                },
                                                "description": {
                                                  "description": "Alt text; null if none.",
                                                  "type": [
                                                    "string",
                                                    "null"
                                                  ]
                                                },
                                                "meta": {
                                                  "type": "object",
                                                  "properties": {
                                                    "original": {
                                                      "anyOf": [
                                                        {
                                                          "type": "object",
                                                          "properties": {
                                                            "width": {
                                                              "description": "Width in pixels.",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            },
                                                            "height": {
                                                              "description": "Height in pixels.",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            },
                                                            "aspect": {
                                                              "description": "Width / height; null when not reported (videos).",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            },
                                                            "duration": {
                                                              "description": "Length in seconds, for video and audio; else null.",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            }
                                                          },
                                                          "required": [
                                                            "width",
                                                            "height",
                                                            "aspect",
                                                            "duration"
                                                          ],
                                                          "additionalProperties": false
                                                        },
                                                        {
                                                          "type": "null"
                                                        }
                                                      ],
                                                      "description": "Size of the file at `url`."
                                                    },
                                                    "small": {
                                                      "anyOf": [
                                                        {
                                                          "type": "object",
                                                          "properties": {
                                                            "width": {
                                                              "description": "Width in pixels.",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            },
                                                            "height": {
                                                              "description": "Height in pixels.",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            },
                                                            "aspect": {
                                                              "description": "Width / height; null when not reported (videos).",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            },
                                                            "duration": {
                                                              "description": "Length in seconds, for video and audio; else null.",
                                                              "type": [
                                                                "number",
                                                                "null"
                                                              ]
                                                            }
                                                          },
                                                          "required": [
                                                            "width",
                                                            "height",
                                                            "aspect",
                                                            "duration"
                                                          ],
                                                          "additionalProperties": false
                                                        },
                                                        {
                                                          "type": "null"
                                                        }
                                                      ],
                                                      "description": "Size of the image at `preview_url`."
                                                    }
                                                  },
                                                  "required": [
                                                    "original",
                                                    "small"
                                                  ],
                                                  "additionalProperties": false,
                                                  "description": "Sizes, as Mastodon reports them."
                                                }
                                              },
                                              "required": [
                                                "id",
                                                "type",
                                                "url",
                                                "preview_url",
                                                "description",
                                                "meta"
                                              ],
                                              "additionalProperties": false
                                            },
                                            "description": "Images and videos, in order."
                                          },
                                          "card": {
                                            "anyOf": [
                                              {
                                                "type": "object",
                                                "properties": {
                                                  "url": {
                                                    "type": "string",
                                                    "description": "The linked page."
                                                  },
                                                  "title": {
                                                    "description": "Page title.",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  },
                                                  "description": {
                                                    "description": "Page description.",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  },
                                                  "type": {
                                                    "description": "`link`, `video`, `photo` or `rich`.",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  },
                                                  "provider_name": {
                                                    "description": "Site name, e.g. `x.com`.",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  },
                                                  "image": {
                                                    "description": "Preview image URL (hosted by Truth Social).",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  }
                                                },
                                                "required": [
                                                  "url",
                                                  "title",
                                                  "description",
                                                  "type",
                                                  "provider_name",
                                                  "image"
                                                ],
                                                "additionalProperties": false
                                              },
                                              {
                                                "type": "null"
                                              }
                                            ],
                                            "description": "Link preview for the first link in the post; null if none."
                                          },
                                          "group": {
                                            "anyOf": [
                                              {
                                                "type": "object",
                                                "properties": {
                                                  "id": {
                                                    "type": "string",
                                                    "description": "Group id."
                                                  },
                                                  "display_name": {
                                                    "type": "string",
                                                    "description": "Group name."
                                                  },
                                                  "slug": {
                                                    "description": "URL name, e.g. `republicans`.",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  },
                                                  "url": {
                                                    "description": "Group on truthsocial.com.",
                                                    "type": [
                                                      "string",
                                                      "null"
                                                    ]
                                                  },
                                                  "members_count": {
                                                    "description": "Members.",
                                                    "type": [
                                                      "number",
                                                      "null"
                                                    ]
                                                  }
                                                },
                                                "required": [
                                                  "id",
                                                  "display_name",
                                                  "slug",
                                                  "url",
                                                  "members_count"
                                                ],
                                                "additionalProperties": false
                                              },
                                              {
                                                "type": "null"
                                              }
                                            ],
                                            "description": "The group it was posted in; null for ordinary posts."
                                          },
                                          "mentions": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "properties": {
                                                "id": {
                                                  "type": "string",
                                                  "description": "Account id."
                                                },
                                                "username": {
                                                  "type": "string",
                                                  "description": "Username without @."
                                                },
                                                "acct": {
                                                  "type": "string",
                                                  "description": "Same as username."
                                                },
                                                "url": {
                                                  "type": "string",
                                                  "description": "Profile on truthsocial.com."
                                                }
                                              },
                                              "required": [
                                                "id",
                                                "username",
                                                "acct",
                                                "url"
                                              ],
                                              "additionalProperties": false
                                            },
                                            "description": "Accounts mentioned; quote posts also list the quoted post's author."
                                          },
                                          "tags": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "properties": {
                                                "name": {
                                                  "type": "string",
                                                  "description": "Hashtag without #."
                                                },
                                                "url": {
                                                  "type": "string",
                                                  "description": "Hashtag page on truthsocial.com."
                                                }
                                              },
                                              "required": [
                                                "name",
                                                "url"
                                              ],
                                              "additionalProperties": false
                                            },
                                            "description": "Hashtags used."
                                          },
                                          "account": {
                                            "type": "object",
                                            "properties": {
                                              "id": {
                                                "type": "string",
                                                "description": "Account id."
                                              },
                                              "username": {
                                                "type": "string",
                                                "description": "Username without @."
                                              },
                                              "acct": {
                                                "type": "string",
                                                "description": "Same as username."
                                              },
                                              "display_name": {
                                                "type": "string",
                                                "description": "Display name."
                                              },
                                              "url": {
                                                "type": "string",
                                                "description": "Profile on truthsocial.com."
                                              },
                                              "avatar": {
                                                "description": "Profile picture URL; null if none.",
                                                "type": [
                                                  "string",
                                                  "null"
                                                ]
                                              },
                                              "verified": {
                                                "type": "boolean",
                                                "description": "Has the verified badge."
                                              },
                                              "followers_count": {
                                                "type": "number",
                                                "description": "Followers."
                                              }
                                            },
                                            "required": [
                                              "id",
                                              "username",
                                              "acct",
                                              "display_name",
                                              "url",
                                              "avatar",
                                              "verified",
                                              "followers_count"
                                            ],
                                            "additionalProperties": false,
                                            "description": "The author."
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "created_at",
                                          "url",
                                          "text",
                                          "title",
                                          "language",
                                          "visibility",
                                          "sensitive",
                                          "spoiler_text",
                                          "in_reply_to_id",
                                          "in_reply_to_account_id",
                                          "quote_id",
                                          "replies_count",
                                          "reblogs_count",
                                          "favourites_count",
                                          "upvotes_count",
                                          "downvotes_count",
                                          "edited_at",
                                          "media_attachments",
                                          "card",
                                          "group",
                                          "mentions",
                                          "tags",
                                          "account"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "On a quote post: the quoted post. null otherwise."
                                  }
                                },
                                "required": [
                                  "id",
                                  "created_at",
                                  "url",
                                  "text",
                                  "title",
                                  "language",
                                  "visibility",
                                  "sensitive",
                                  "spoiler_text",
                                  "in_reply_to_id",
                                  "in_reply_to_account_id",
                                  "quote_id",
                                  "replies_count",
                                  "reblogs_count",
                                  "favourites_count",
                                  "upvotes_count",
                                  "downvotes_count",
                                  "edited_at",
                                  "media_attachments",
                                  "card",
                                  "group",
                                  "mentions",
                                  "tags",
                                  "account",
                                  "quote"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "On a ReTruth (repost): the original post with its text and counts (the outer post's counts are the ReTruth's own), and the post it quotes in `reblog.quote`. null otherwise."
                          },
                          "quote": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Post id, e.g. `117351985093810875`."
                                  },
                                  "created_at": {
                                    "type": "string",
                                    "description": "Posted at, ISO 8601."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The post on truthsocial.com."
                                  },
                                  "content": {
                                    "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                                    "type": "string"
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                                  },
                                  "title": {
                                    "description": "Title, on group posts that have one; else null.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "language": {
                                    "description": "Language code (e.g. `en`) when detected; often null.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "visibility": {
                                    "type": "string",
                                    "description": "`public`, or `group` for posts in a group."
                                  },
                                  "sensitive": {
                                    "type": "boolean",
                                    "description": "Marked sensitive (media hidden behind a warning)."
                                  },
                                  "spoiler_text": {
                                    "type": "string",
                                    "description": "Content warning; empty if none."
                                  },
                                  "in_reply_to_id": {
                                    "description": "The post this replies to; null if not a reply.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "in_reply_to_account_id": {
                                    "description": "Author of the post this replies to.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "quote_id": {
                                    "description": "The quoted post's id; null if not a quote.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "replies_count": {
                                    "type": "number",
                                    "description": "Replies."
                                  },
                                  "reblogs_count": {
                                    "type": "number",
                                    "description": "ReTruths (reposts)."
                                  },
                                  "favourites_count": {
                                    "type": "number",
                                    "description": "Likes."
                                  },
                                  "upvotes_count": {
                                    "description": "Upvotes (Truth Social's likes); null if not reported.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "downvotes_count": {
                                    "description": "Downvotes; null if not reported.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "edited_at": {
                                    "description": "Last edit, ISO 8601; null if never edited.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "media_attachments": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "type": "string",
                                          "description": "Attachment id."
                                        },
                                        "type": {
                                          "type": "string",
                                          "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                        },
                                        "url": {
                                          "description": "The file (full-size image or MP4).",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "preview_url": {
                                          "description": "A smaller image, or the video's thumbnail.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "description": {
                                          "description": "Alt text; null if none.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "meta": {
                                          "type": "object",
                                          "properties": {
                                            "original": {
                                              "anyOf": [
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "width": {
                                                      "description": "Width in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "height": {
                                                      "description": "Height in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "aspect": {
                                                      "description": "Width / height; null when not reported (videos).",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "duration": {
                                                      "description": "Length in seconds, for video and audio; else null.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    }
                                                  },
                                                  "required": [
                                                    "width",
                                                    "height",
                                                    "aspect",
                                                    "duration"
                                                  ],
                                                  "additionalProperties": false
                                                },
                                                {
                                                  "type": "null"
                                                }
                                              ],
                                              "description": "Size of the file at `url`."
                                            },
                                            "small": {
                                              "anyOf": [
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "width": {
                                                      "description": "Width in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "height": {
                                                      "description": "Height in pixels.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "aspect": {
                                                      "description": "Width / height; null when not reported (videos).",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    },
                                                    "duration": {
                                                      "description": "Length in seconds, for video and audio; else null.",
                                                      "type": [
                                                        "number",
                                                        "null"
                                                      ]
                                                    }
                                                  },
                                                  "required": [
                                                    "width",
                                                    "height",
                                                    "aspect",
                                                    "duration"
                                                  ],
                                                  "additionalProperties": false
                                                },
                                                {
                                                  "type": "null"
                                                }
                                              ],
                                              "description": "Size of the image at `preview_url`."
                                            }
                                          },
                                          "required": [
                                            "original",
                                            "small"
                                          ],
                                          "additionalProperties": false,
                                          "description": "Sizes, as Mastodon reports them."
                                        }
                                      },
                                      "required": [
                                        "id",
                                        "type",
                                        "url",
                                        "preview_url",
                                        "description",
                                        "meta"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Images and videos, in order."
                                  },
                                  "card": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "url": {
                                            "type": "string",
                                            "description": "The linked page."
                                          },
                                          "title": {
                                            "description": "Page title.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "description": {
                                            "description": "Page description.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "type": {
                                            "description": "`link`, `video`, `photo` or `rich`.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "provider_name": {
                                            "description": "Site name, e.g. `x.com`.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "image": {
                                            "description": "Preview image URL (hosted by Truth Social).",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "url",
                                          "title",
                                          "description",
                                          "type",
                                          "provider_name",
                                          "image"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "Link preview for the first link in the post; null if none."
                                  },
                                  "group": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "type": "string",
                                            "description": "Group id."
                                          },
                                          "display_name": {
                                            "type": "string",
                                            "description": "Group name."
                                          },
                                          "slug": {
                                            "description": "URL name, e.g. `republicans`.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "url": {
                                            "description": "Group on truthsocial.com.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "members_count": {
                                            "description": "Members.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "display_name",
                                          "slug",
                                          "url",
                                          "members_count"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The group it was posted in; null for ordinary posts."
                                  },
                                  "mentions": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "type": "string",
                                          "description": "Account id."
                                        },
                                        "username": {
                                          "type": "string",
                                          "description": "Username without @."
                                        },
                                        "acct": {
                                          "type": "string",
                                          "description": "Same as username."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "Profile on truthsocial.com."
                                        }
                                      },
                                      "required": [
                                        "id",
                                        "username",
                                        "acct",
                                        "url"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Accounts mentioned; quote posts also list the quoted post's author."
                                  },
                                  "tags": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "name": {
                                          "type": "string",
                                          "description": "Hashtag without #."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "Hashtag page on truthsocial.com."
                                        }
                                      },
                                      "required": [
                                        "name",
                                        "url"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Hashtags used."
                                  },
                                  "account": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "string",
                                        "description": "Account id."
                                      },
                                      "username": {
                                        "type": "string",
                                        "description": "Username without @."
                                      },
                                      "acct": {
                                        "type": "string",
                                        "description": "Same as username."
                                      },
                                      "display_name": {
                                        "type": "string",
                                        "description": "Display name."
                                      },
                                      "url": {
                                        "type": "string",
                                        "description": "Profile on truthsocial.com."
                                      },
                                      "avatar": {
                                        "description": "Profile picture URL; null if none.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "verified": {
                                        "type": "boolean",
                                        "description": "Has the verified badge."
                                      },
                                      "followers_count": {
                                        "type": "number",
                                        "description": "Followers."
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "username",
                                      "acct",
                                      "display_name",
                                      "url",
                                      "avatar",
                                      "verified",
                                      "followers_count"
                                    ],
                                    "additionalProperties": false,
                                    "description": "The author."
                                  }
                                },
                                "required": [
                                  "id",
                                  "created_at",
                                  "url",
                                  "text",
                                  "title",
                                  "language",
                                  "visibility",
                                  "sensitive",
                                  "spoiler_text",
                                  "in_reply_to_id",
                                  "in_reply_to_account_id",
                                  "quote_id",
                                  "replies_count",
                                  "reblogs_count",
                                  "favourites_count",
                                  "upvotes_count",
                                  "downvotes_count",
                                  "edited_at",
                                  "media_attachments",
                                  "card",
                                  "group",
                                  "mentions",
                                  "tags",
                                  "account"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "On a quote post: the quoted post. null otherwise."
                          }
                        },
                        "required": [
                          "id",
                          "created_at",
                          "url",
                          "text",
                          "title",
                          "language",
                          "visibility",
                          "sensitive",
                          "spoiler_text",
                          "in_reply_to_id",
                          "in_reply_to_account_id",
                          "quote_id",
                          "replies_count",
                          "reblogs_count",
                          "favourites_count",
                          "upvotes_count",
                          "downvotes_count",
                          "edited_at",
                          "media_attachments",
                          "card",
                          "group",
                          "mentions",
                          "tags",
                          "account",
                          "reblog",
                          "quote"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Posts and ReTruths, newest first."
                    },
                    "next_max_id": {
                      "description": "Pass as `next_max_id` for older posts. null when this page is empty.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "next_max_id"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/truthsocial/post": {
      "get": {
        "operationId": "truthsocial_post",
        "tags": [
          "Truth Social"
        ],
        "summary": "Post",
        "description": "One post with its text, media, link preview and engagement counts.\n\nUse it to read or track a single post: text (HTML and plain), images and videos, link preview, and reply, ReTruth, like and upvote counts. ReTruths carry the original in `reblog`, quote posts the quoted post in `quote`.\n\nPass the post's URL (`https://truthsocial.com/@<name>/posts/<id>`, `/@<name>/<id>` or a group post URL) or its numeric id.\n\nUnknown and deleted posts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/truthsocial/post"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The post's URL, e.g. `https://truthsocial.com/@realDonaldTrump/posts/117351985093810875`, or its id.",
            "schema": {
              "type": "string",
              "description": "The post's URL, e.g. `https://truthsocial.com/@realDonaldTrump/posts/117351985093810875`, or its id."
            },
            "example": "https://truthsocial.com/@realDonaldTrump/posts/117351985093810875"
          }
        ],
        "responses": {
          "200": {
            "description": "One post with its text, media, link preview and engagement counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Post id, e.g. `117351985093810875`."
                    },
                    "created_at": {
                      "type": "string",
                      "description": "Posted at, ISO 8601."
                    },
                    "url": {
                      "type": "string",
                      "description": "The post on truthsocial.com."
                    },
                    "content": {
                      "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                      "type": "string"
                    },
                    "text": {
                      "type": "string",
                      "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                    },
                    "title": {
                      "description": "Title, on group posts that have one; else null.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "language": {
                      "description": "Language code (e.g. `en`) when detected; often null.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "visibility": {
                      "type": "string",
                      "description": "`public`, or `group` for posts in a group."
                    },
                    "sensitive": {
                      "type": "boolean",
                      "description": "Marked sensitive (media hidden behind a warning)."
                    },
                    "spoiler_text": {
                      "type": "string",
                      "description": "Content warning; empty if none."
                    },
                    "in_reply_to_id": {
                      "description": "The post this replies to; null if not a reply.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "in_reply_to_account_id": {
                      "description": "Author of the post this replies to.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "quote_id": {
                      "description": "The quoted post's id; null if not a quote.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "replies_count": {
                      "type": "number",
                      "description": "Replies."
                    },
                    "reblogs_count": {
                      "type": "number",
                      "description": "ReTruths (reposts)."
                    },
                    "favourites_count": {
                      "type": "number",
                      "description": "Likes."
                    },
                    "upvotes_count": {
                      "description": "Upvotes (Truth Social's likes); null if not reported.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "downvotes_count": {
                      "description": "Downvotes; null if not reported.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "edited_at": {
                      "description": "Last edit, ISO 8601; null if never edited.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "media_attachments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Attachment id."
                          },
                          "type": {
                            "type": "string",
                            "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                          },
                          "url": {
                            "description": "The file (full-size image or MP4).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "preview_url": {
                            "description": "A smaller image, or the video's thumbnail.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "description": {
                            "description": "Alt text; null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "meta": {
                            "type": "object",
                            "properties": {
                              "original": {
                                "anyOf": [
                                  {
                                    "type": "object",
                                    "properties": {
                                      "width": {
                                        "description": "Width in pixels.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "height": {
                                        "description": "Height in pixels.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "aspect": {
                                        "description": "Width / height; null when not reported (videos).",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "duration": {
                                        "description": "Length in seconds, for video and audio; else null.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "width",
                                      "height",
                                      "aspect",
                                      "duration"
                                    ],
                                    "additionalProperties": false
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "Size of the file at `url`."
                              },
                              "small": {
                                "anyOf": [
                                  {
                                    "type": "object",
                                    "properties": {
                                      "width": {
                                        "description": "Width in pixels.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "height": {
                                        "description": "Height in pixels.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "aspect": {
                                        "description": "Width / height; null when not reported (videos).",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "duration": {
                                        "description": "Length in seconds, for video and audio; else null.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "width",
                                      "height",
                                      "aspect",
                                      "duration"
                                    ],
                                    "additionalProperties": false
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "Size of the image at `preview_url`."
                              }
                            },
                            "required": [
                              "original",
                              "small"
                            ],
                            "additionalProperties": false,
                            "description": "Sizes, as Mastodon reports them."
                          }
                        },
                        "required": [
                          "id",
                          "type",
                          "url",
                          "preview_url",
                          "description",
                          "meta"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Images and videos, in order."
                    },
                    "card": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "url": {
                              "type": "string",
                              "description": "The linked page."
                            },
                            "title": {
                              "description": "Page title.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "description": {
                              "description": "Page description.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "type": {
                              "description": "`link`, `video`, `photo` or `rich`.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "provider_name": {
                              "description": "Site name, e.g. `x.com`.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "image": {
                              "description": "Preview image URL (hosted by Truth Social).",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "url",
                            "title",
                            "description",
                            "type",
                            "provider_name",
                            "image"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Link preview for the first link in the post; null if none."
                    },
                    "group": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Group id."
                            },
                            "display_name": {
                              "type": "string",
                              "description": "Group name."
                            },
                            "slug": {
                              "description": "URL name, e.g. `republicans`.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "url": {
                              "description": "Group on truthsocial.com.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "members_count": {
                              "description": "Members.",
                              "type": [
                                "number",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "display_name",
                            "slug",
                            "url",
                            "members_count"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The group it was posted in; null for ordinary posts."
                    },
                    "mentions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Account id."
                          },
                          "username": {
                            "type": "string",
                            "description": "Username without @."
                          },
                          "acct": {
                            "type": "string",
                            "description": "Same as username."
                          },
                          "url": {
                            "type": "string",
                            "description": "Profile on truthsocial.com."
                          }
                        },
                        "required": [
                          "id",
                          "username",
                          "acct",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Accounts mentioned; quote posts also list the quoted post's author."
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Hashtag without #."
                          },
                          "url": {
                            "type": "string",
                            "description": "Hashtag page on truthsocial.com."
                          }
                        },
                        "required": [
                          "name",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Hashtags used."
                    },
                    "account": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Account id."
                        },
                        "username": {
                          "type": "string",
                          "description": "Username without @."
                        },
                        "acct": {
                          "type": "string",
                          "description": "Same as username."
                        },
                        "display_name": {
                          "type": "string",
                          "description": "Display name."
                        },
                        "url": {
                          "type": "string",
                          "description": "Profile on truthsocial.com."
                        },
                        "avatar": {
                          "description": "Profile picture URL; null if none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has the verified badge."
                        },
                        "followers_count": {
                          "type": "number",
                          "description": "Followers."
                        }
                      },
                      "required": [
                        "id",
                        "username",
                        "acct",
                        "display_name",
                        "url",
                        "avatar",
                        "verified",
                        "followers_count"
                      ],
                      "additionalProperties": false,
                      "description": "The author."
                    },
                    "reblog": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Post id, e.g. `117351985093810875`."
                            },
                            "created_at": {
                              "type": "string",
                              "description": "Posted at, ISO 8601."
                            },
                            "url": {
                              "type": "string",
                              "description": "The post on truthsocial.com."
                            },
                            "content": {
                              "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                              "type": "string"
                            },
                            "text": {
                              "type": "string",
                              "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                            },
                            "title": {
                              "description": "Title, on group posts that have one; else null.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "language": {
                              "description": "Language code (e.g. `en`) when detected; often null.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "visibility": {
                              "type": "string",
                              "description": "`public`, or `group` for posts in a group."
                            },
                            "sensitive": {
                              "type": "boolean",
                              "description": "Marked sensitive (media hidden behind a warning)."
                            },
                            "spoiler_text": {
                              "type": "string",
                              "description": "Content warning; empty if none."
                            },
                            "in_reply_to_id": {
                              "description": "The post this replies to; null if not a reply.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "in_reply_to_account_id": {
                              "description": "Author of the post this replies to.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "quote_id": {
                              "description": "The quoted post's id; null if not a quote.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "replies_count": {
                              "type": "number",
                              "description": "Replies."
                            },
                            "reblogs_count": {
                              "type": "number",
                              "description": "ReTruths (reposts)."
                            },
                            "favourites_count": {
                              "type": "number",
                              "description": "Likes."
                            },
                            "upvotes_count": {
                              "description": "Upvotes (Truth Social's likes); null if not reported.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "downvotes_count": {
                              "description": "Downvotes; null if not reported.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "edited_at": {
                              "description": "Last edit, ISO 8601; null if never edited.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "media_attachments": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Attachment id."
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                  },
                                  "url": {
                                    "description": "The file (full-size image or MP4).",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "preview_url": {
                                    "description": "A smaller image, or the video's thumbnail.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "description": {
                                    "description": "Alt text; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "meta": {
                                    "type": "object",
                                    "properties": {
                                      "original": {
                                        "anyOf": [
                                          {
                                            "type": "object",
                                            "properties": {
                                              "width": {
                                                "description": "Width in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "height": {
                                                "description": "Height in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "aspect": {
                                                "description": "Width / height; null when not reported (videos).",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "duration": {
                                                "description": "Length in seconds, for video and audio; else null.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "width",
                                              "height",
                                              "aspect",
                                              "duration"
                                            ],
                                            "additionalProperties": false
                                          },
                                          {
                                            "type": "null"
                                          }
                                        ],
                                        "description": "Size of the file at `url`."
                                      },
                                      "small": {
                                        "anyOf": [
                                          {
                                            "type": "object",
                                            "properties": {
                                              "width": {
                                                "description": "Width in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "height": {
                                                "description": "Height in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "aspect": {
                                                "description": "Width / height; null when not reported (videos).",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "duration": {
                                                "description": "Length in seconds, for video and audio; else null.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "width",
                                              "height",
                                              "aspect",
                                              "duration"
                                            ],
                                            "additionalProperties": false
                                          },
                                          {
                                            "type": "null"
                                          }
                                        ],
                                        "description": "Size of the image at `preview_url`."
                                      }
                                    },
                                    "required": [
                                      "original",
                                      "small"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Sizes, as Mastodon reports them."
                                  }
                                },
                                "required": [
                                  "id",
                                  "type",
                                  "url",
                                  "preview_url",
                                  "description",
                                  "meta"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Images and videos, in order."
                            },
                            "card": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "The linked page."
                                    },
                                    "title": {
                                      "description": "Page title.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "description": {
                                      "description": "Page description.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "type": {
                                      "description": "`link`, `video`, `photo` or `rich`.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "provider_name": {
                                      "description": "Site name, e.g. `x.com`.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "image": {
                                      "description": "Preview image URL (hosted by Truth Social).",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "title",
                                    "description",
                                    "type",
                                    "provider_name",
                                    "image"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Link preview for the first link in the post; null if none."
                            },
                            "group": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "description": "Group id."
                                    },
                                    "display_name": {
                                      "type": "string",
                                      "description": "Group name."
                                    },
                                    "slug": {
                                      "description": "URL name, e.g. `republicans`.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "url": {
                                      "description": "Group on truthsocial.com.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "members_count": {
                                      "description": "Members.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "display_name",
                                    "slug",
                                    "url",
                                    "members_count"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The group it was posted in; null for ordinary posts."
                            },
                            "mentions": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Account id."
                                  },
                                  "username": {
                                    "type": "string",
                                    "description": "Username without @."
                                  },
                                  "acct": {
                                    "type": "string",
                                    "description": "Same as username."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Profile on truthsocial.com."
                                  }
                                },
                                "required": [
                                  "id",
                                  "username",
                                  "acct",
                                  "url"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Accounts mentioned; quote posts also list the quoted post's author."
                            },
                            "tags": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Hashtag without #."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Hashtag page on truthsocial.com."
                                  }
                                },
                                "required": [
                                  "name",
                                  "url"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Hashtags used."
                            },
                            "account": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "description": "Account id."
                                },
                                "username": {
                                  "type": "string",
                                  "description": "Username without @."
                                },
                                "acct": {
                                  "type": "string",
                                  "description": "Same as username."
                                },
                                "display_name": {
                                  "type": "string",
                                  "description": "Display name."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "Profile on truthsocial.com."
                                },
                                "avatar": {
                                  "description": "Profile picture URL; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "verified": {
                                  "type": "boolean",
                                  "description": "Has the verified badge."
                                },
                                "followers_count": {
                                  "type": "number",
                                  "description": "Followers."
                                }
                              },
                              "required": [
                                "id",
                                "username",
                                "acct",
                                "display_name",
                                "url",
                                "avatar",
                                "verified",
                                "followers_count"
                              ],
                              "additionalProperties": false,
                              "description": "The author."
                            },
                            "quote": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "description": "Post id, e.g. `117351985093810875`."
                                    },
                                    "created_at": {
                                      "type": "string",
                                      "description": "Posted at, ISO 8601."
                                    },
                                    "url": {
                                      "type": "string",
                                      "description": "The post on truthsocial.com."
                                    },
                                    "content": {
                                      "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                                      "type": "string"
                                    },
                                    "text": {
                                      "type": "string",
                                      "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                                    },
                                    "title": {
                                      "description": "Title, on group posts that have one; else null.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "language": {
                                      "description": "Language code (e.g. `en`) when detected; often null.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "visibility": {
                                      "type": "string",
                                      "description": "`public`, or `group` for posts in a group."
                                    },
                                    "sensitive": {
                                      "type": "boolean",
                                      "description": "Marked sensitive (media hidden behind a warning)."
                                    },
                                    "spoiler_text": {
                                      "type": "string",
                                      "description": "Content warning; empty if none."
                                    },
                                    "in_reply_to_id": {
                                      "description": "The post this replies to; null if not a reply.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "in_reply_to_account_id": {
                                      "description": "Author of the post this replies to.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "quote_id": {
                                      "description": "The quoted post's id; null if not a quote.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "replies_count": {
                                      "type": "number",
                                      "description": "Replies."
                                    },
                                    "reblogs_count": {
                                      "type": "number",
                                      "description": "ReTruths (reposts)."
                                    },
                                    "favourites_count": {
                                      "type": "number",
                                      "description": "Likes."
                                    },
                                    "upvotes_count": {
                                      "description": "Upvotes (Truth Social's likes); null if not reported.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "downvotes_count": {
                                      "description": "Downvotes; null if not reported.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "edited_at": {
                                      "description": "Last edit, ISO 8601; null if never edited.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "media_attachments": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "type": "string",
                                            "description": "Attachment id."
                                          },
                                          "type": {
                                            "type": "string",
                                            "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                          },
                                          "url": {
                                            "description": "The file (full-size image or MP4).",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "preview_url": {
                                            "description": "A smaller image, or the video's thumbnail.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "description": {
                                            "description": "Alt text; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "meta": {
                                            "type": "object",
                                            "properties": {
                                              "original": {
                                                "anyOf": [
                                                  {
                                                    "type": "object",
                                                    "properties": {
                                                      "width": {
                                                        "description": "Width in pixels.",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      },
                                                      "height": {
                                                        "description": "Height in pixels.",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      },
                                                      "aspect": {
                                                        "description": "Width / height; null when not reported (videos).",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      },
                                                      "duration": {
                                                        "description": "Length in seconds, for video and audio; else null.",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      }
                                                    },
                                                    "required": [
                                                      "width",
                                                      "height",
                                                      "aspect",
                                                      "duration"
                                                    ],
                                                    "additionalProperties": false
                                                  },
                                                  {
                                                    "type": "null"
                                                  }
                                                ],
                                                "description": "Size of the file at `url`."
                                              },
                                              "small": {
                                                "anyOf": [
                                                  {
                                                    "type": "object",
                                                    "properties": {
                                                      "width": {
                                                        "description": "Width in pixels.",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      },
                                                      "height": {
                                                        "description": "Height in pixels.",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      },
                                                      "aspect": {
                                                        "description": "Width / height; null when not reported (videos).",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      },
                                                      "duration": {
                                                        "description": "Length in seconds, for video and audio; else null.",
                                                        "type": [
                                                          "number",
                                                          "null"
                                                        ]
                                                      }
                                                    },
                                                    "required": [
                                                      "width",
                                                      "height",
                                                      "aspect",
                                                      "duration"
                                                    ],
                                                    "additionalProperties": false
                                                  },
                                                  {
                                                    "type": "null"
                                                  }
                                                ],
                                                "description": "Size of the image at `preview_url`."
                                              }
                                            },
                                            "required": [
                                              "original",
                                              "small"
                                            ],
                                            "additionalProperties": false,
                                            "description": "Sizes, as Mastodon reports them."
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "type",
                                          "url",
                                          "preview_url",
                                          "description",
                                          "meta"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "Images and videos, in order."
                                    },
                                    "card": {
                                      "anyOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "url": {
                                              "type": "string",
                                              "description": "The linked page."
                                            },
                                            "title": {
                                              "description": "Page title.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "description": {
                                              "description": "Page description.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "type": {
                                              "description": "`link`, `video`, `photo` or `rich`.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "provider_name": {
                                              "description": "Site name, e.g. `x.com`.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "image": {
                                              "description": "Preview image URL (hosted by Truth Social).",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "url",
                                            "title",
                                            "description",
                                            "type",
                                            "provider_name",
                                            "image"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "null"
                                        }
                                      ],
                                      "description": "Link preview for the first link in the post; null if none."
                                    },
                                    "group": {
                                      "anyOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "id": {
                                              "type": "string",
                                              "description": "Group id."
                                            },
                                            "display_name": {
                                              "type": "string",
                                              "description": "Group name."
                                            },
                                            "slug": {
                                              "description": "URL name, e.g. `republicans`.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "url": {
                                              "description": "Group on truthsocial.com.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "members_count": {
                                              "description": "Members.",
                                              "type": [
                                                "number",
                                                "null"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "id",
                                            "display_name",
                                            "slug",
                                            "url",
                                            "members_count"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "null"
                                        }
                                      ],
                                      "description": "The group it was posted in; null for ordinary posts."
                                    },
                                    "mentions": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "type": "string",
                                            "description": "Account id."
                                          },
                                          "username": {
                                            "type": "string",
                                            "description": "Username without @."
                                          },
                                          "acct": {
                                            "type": "string",
                                            "description": "Same as username."
                                          },
                                          "url": {
                                            "type": "string",
                                            "description": "Profile on truthsocial.com."
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "username",
                                          "acct",
                                          "url"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "Accounts mentioned; quote posts also list the quoted post's author."
                                    },
                                    "tags": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "name": {
                                            "type": "string",
                                            "description": "Hashtag without #."
                                          },
                                          "url": {
                                            "type": "string",
                                            "description": "Hashtag page on truthsocial.com."
                                          }
                                        },
                                        "required": [
                                          "name",
                                          "url"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "Hashtags used."
                                    },
                                    "account": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "type": "string",
                                          "description": "Account id."
                                        },
                                        "username": {
                                          "type": "string",
                                          "description": "Username without @."
                                        },
                                        "acct": {
                                          "type": "string",
                                          "description": "Same as username."
                                        },
                                        "display_name": {
                                          "type": "string",
                                          "description": "Display name."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "Profile on truthsocial.com."
                                        },
                                        "avatar": {
                                          "description": "Profile picture URL; null if none.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "verified": {
                                          "type": "boolean",
                                          "description": "Has the verified badge."
                                        },
                                        "followers_count": {
                                          "type": "number",
                                          "description": "Followers."
                                        }
                                      },
                                      "required": [
                                        "id",
                                        "username",
                                        "acct",
                                        "display_name",
                                        "url",
                                        "avatar",
                                        "verified",
                                        "followers_count"
                                      ],
                                      "additionalProperties": false,
                                      "description": "The author."
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "created_at",
                                    "url",
                                    "text",
                                    "title",
                                    "language",
                                    "visibility",
                                    "sensitive",
                                    "spoiler_text",
                                    "in_reply_to_id",
                                    "in_reply_to_account_id",
                                    "quote_id",
                                    "replies_count",
                                    "reblogs_count",
                                    "favourites_count",
                                    "upvotes_count",
                                    "downvotes_count",
                                    "edited_at",
                                    "media_attachments",
                                    "card",
                                    "group",
                                    "mentions",
                                    "tags",
                                    "account"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "On a quote post: the quoted post. null otherwise."
                            }
                          },
                          "required": [
                            "id",
                            "created_at",
                            "url",
                            "text",
                            "title",
                            "language",
                            "visibility",
                            "sensitive",
                            "spoiler_text",
                            "in_reply_to_id",
                            "in_reply_to_account_id",
                            "quote_id",
                            "replies_count",
                            "reblogs_count",
                            "favourites_count",
                            "upvotes_count",
                            "downvotes_count",
                            "edited_at",
                            "media_attachments",
                            "card",
                            "group",
                            "mentions",
                            "tags",
                            "account",
                            "quote"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "On a ReTruth (repost): the original post with its text and counts (the outer post's counts are the ReTruth's own), and the post it quotes in `reblog.quote`. null otherwise."
                    },
                    "quote": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Post id, e.g. `117351985093810875`."
                            },
                            "created_at": {
                              "type": "string",
                              "description": "Posted at, ISO 8601."
                            },
                            "url": {
                              "type": "string",
                              "description": "The post on truthsocial.com."
                            },
                            "content": {
                              "description": "Post text as HTML, as Truth Social sends it: a quote post's starts with a hidden `.quote-inline` link to the quoted post, and a ReTruth's reads `RT @author` (Mastodon clients hide or skip both). Omitted with trim=true.",
                              "type": "string"
                            },
                            "text": {
                              "type": "string",
                              "description": "Post text, plain, as Truth Social shows it (a quote's link to the quoted post left out). Empty for media-only posts and ReTruths."
                            },
                            "title": {
                              "description": "Title, on group posts that have one; else null.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "language": {
                              "description": "Language code (e.g. `en`) when detected; often null.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "visibility": {
                              "type": "string",
                              "description": "`public`, or `group` for posts in a group."
                            },
                            "sensitive": {
                              "type": "boolean",
                              "description": "Marked sensitive (media hidden behind a warning)."
                            },
                            "spoiler_text": {
                              "type": "string",
                              "description": "Content warning; empty if none."
                            },
                            "in_reply_to_id": {
                              "description": "The post this replies to; null if not a reply.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "in_reply_to_account_id": {
                              "description": "Author of the post this replies to.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "quote_id": {
                              "description": "The quoted post's id; null if not a quote.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "replies_count": {
                              "type": "number",
                              "description": "Replies."
                            },
                            "reblogs_count": {
                              "type": "number",
                              "description": "ReTruths (reposts)."
                            },
                            "favourites_count": {
                              "type": "number",
                              "description": "Likes."
                            },
                            "upvotes_count": {
                              "description": "Upvotes (Truth Social's likes); null if not reported.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "downvotes_count": {
                              "description": "Downvotes; null if not reported.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "edited_at": {
                              "description": "Last edit, ISO 8601; null if never edited.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "media_attachments": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Attachment id."
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "`image`, `video`, `gifv`, `audio` or `unknown`."
                                  },
                                  "url": {
                                    "description": "The file (full-size image or MP4).",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "preview_url": {
                                    "description": "A smaller image, or the video's thumbnail.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "description": {
                                    "description": "Alt text; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "meta": {
                                    "type": "object",
                                    "properties": {
                                      "original": {
                                        "anyOf": [
                                          {
                                            "type": "object",
                                            "properties": {
                                              "width": {
                                                "description": "Width in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "height": {
                                                "description": "Height in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "aspect": {
                                                "description": "Width / height; null when not reported (videos).",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "duration": {
                                                "description": "Length in seconds, for video and audio; else null.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "width",
                                              "height",
                                              "aspect",
                                              "duration"
                                            ],
                                            "additionalProperties": false
                                          },
                                          {
                                            "type": "null"
                                          }
                                        ],
                                        "description": "Size of the file at `url`."
                                      },
                                      "small": {
                                        "anyOf": [
                                          {
                                            "type": "object",
                                            "properties": {
                                              "width": {
                                                "description": "Width in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "height": {
                                                "description": "Height in pixels.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "aspect": {
                                                "description": "Width / height; null when not reported (videos).",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              },
                                              "duration": {
                                                "description": "Length in seconds, for video and audio; else null.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "width",
                                              "height",
                                              "aspect",
                                              "duration"
                                            ],
                                            "additionalProperties": false
                                          },
                                          {
                                            "type": "null"
                                          }
                                        ],
                                        "description": "Size of the image at `preview_url`."
                                      }
                                    },
                                    "required": [
                                      "original",
                                      "small"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Sizes, as Mastodon reports them."
                                  }
                                },
                                "required": [
                                  "id",
                                  "type",
                                  "url",
                                  "preview_url",
                                  "description",
                                  "meta"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Images and videos, in order."
                            },
                            "card": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "The linked page."
                                    },
                                    "title": {
                                      "description": "Page title.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "description": {
                                      "description": "Page description.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "type": {
                                      "description": "`link`, `video`, `photo` or `rich`.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "provider_name": {
                                      "description": "Site name, e.g. `x.com`.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "image": {
                                      "description": "Preview image URL (hosted by Truth Social).",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "title",
                                    "description",
                                    "type",
                                    "provider_name",
                                    "image"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Link preview for the first link in the post; null if none."
                            },
                            "group": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "description": "Group id."
                                    },
                                    "display_name": {
                                      "type": "string",
                                      "description": "Group name."
                                    },
                                    "slug": {
                                      "description": "URL name, e.g. `republicans`.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "url": {
                                      "description": "Group on truthsocial.com.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "members_count": {
                                      "description": "Members.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "display_name",
                                    "slug",
                                    "url",
                                    "members_count"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The group it was posted in; null for ordinary posts."
                            },
                            "mentions": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Account id."
                                  },
                                  "username": {
                                    "type": "string",
                                    "description": "Username without @."
                                  },
                                  "acct": {
                                    "type": "string",
                                    "description": "Same as username."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Profile on truthsocial.com."
                                  }
                                },
                                "required": [
                                  "id",
                                  "username",
                                  "acct",
                                  "url"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Accounts mentioned; quote posts also list the quoted post's author."
                            },
                            "tags": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Hashtag without #."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Hashtag page on truthsocial.com."
                                  }
                                },
                                "required": [
                                  "name",
                                  "url"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Hashtags used."
                            },
                            "account": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "description": "Account id."
                                },
                                "username": {
                                  "type": "string",
                                  "description": "Username without @."
                                },
                                "acct": {
                                  "type": "string",
                                  "description": "Same as username."
                                },
                                "display_name": {
                                  "type": "string",
                                  "description": "Display name."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "Profile on truthsocial.com."
                                },
                                "avatar": {
                                  "description": "Profile picture URL; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "verified": {
                                  "type": "boolean",
                                  "description": "Has the verified badge."
                                },
                                "followers_count": {
                                  "type": "number",
                                  "description": "Followers."
                                }
                              },
                              "required": [
                                "id",
                                "username",
                                "acct",
                                "display_name",
                                "url",
                                "avatar",
                                "verified",
                                "followers_count"
                              ],
                              "additionalProperties": false,
                              "description": "The author."
                            }
                          },
                          "required": [
                            "id",
                            "created_at",
                            "url",
                            "text",
                            "title",
                            "language",
                            "visibility",
                            "sensitive",
                            "spoiler_text",
                            "in_reply_to_id",
                            "in_reply_to_account_id",
                            "quote_id",
                            "replies_count",
                            "reblogs_count",
                            "favourites_count",
                            "upvotes_count",
                            "downvotes_count",
                            "edited_at",
                            "media_attachments",
                            "card",
                            "group",
                            "mentions",
                            "tags",
                            "account"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "On a quote post: the quoted post. null otherwise."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "created_at",
                    "url",
                    "text",
                    "title",
                    "language",
                    "visibility",
                    "sensitive",
                    "spoiler_text",
                    "in_reply_to_id",
                    "in_reply_to_account_id",
                    "quote_id",
                    "replies_count",
                    "reblogs_count",
                    "favourites_count",
                    "upvotes_count",
                    "downvotes_count",
                    "edited_at",
                    "media_attachments",
                    "card",
                    "group",
                    "mentions",
                    "tags",
                    "account",
                    "reblog",
                    "quote"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/telegram/channel": {
      "get": {
        "operationId": "telegram_channel",
        "tags": [
          "Telegram"
        ],
        "summary": "Channel",
        "description": "A public channel's name, bio, photo, exact subscriber count and media counts.\n\nUse it to size up or track a channel. `subscribers` is exact, straight from the channel's t.me page. `counters` (photos, videos, files, links) are rounded by Telegram.\n\nChannels that turned their web preview off still return their name, bio and subscribers, with `previewEnabled: false` and `counters: null`; their posts can't be read.\n\nUnknown usernames, and usernames that belong to a person, bot or group, return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/telegram/channel"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "The channel's username, with or without @ (e.g. `telegram`), or its t.me link.",
            "schema": {
              "description": "The channel's username, with or without @ (e.g. `telegram`), or its t.me link.",
              "type": "string"
            },
            "example": "telegram"
          }
        ],
        "responses": {
          "200": {
            "description": "A public channel's name, bio, photo, exact subscriber count and media counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "username": {
                      "type": "string",
                      "description": "Username without @, as the channel writes it, e.g. `telegram`."
                    },
                    "title": {
                      "type": "string",
                      "description": "Channel name, e.g. \"Telegram News\"."
                    },
                    "description": {
                      "description": "The channel's bio, plain text; null if empty.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "photoUrl": {
                      "description": "Channel photo URL, temporary; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "verified": {
                      "type": "boolean",
                      "description": "Has Telegram's verified badge."
                    },
                    "subscribers": {
                      "description": "Exact subscriber count; null if Telegram doesn't show it.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "counters": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "photos": {
                              "description": "Photos posted, as a number. Telegram rounds it (\"1.2K\" → 1200); null if not shown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "videos": {
                              "description": "Videos posted, as a number. Telegram rounds it (\"1.2K\" → 1200); null if not shown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "files": {
                              "description": "Files posted, as a number. Telegram rounds it (\"1.2K\" → 1200); null if not shown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "links": {
                              "description": "Links posted, as a number. Telegram rounds it (\"1.2K\" → 1200); null if not shown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "photos",
                            "videos",
                            "files",
                            "links"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Media counts from the channel's web preview; null when the preview is off."
                    },
                    "previewEnabled": {
                      "type": "boolean",
                      "description": "The channel's web preview is on, so the channel posts and post endpoints can read its posts."
                    },
                    "url": {
                      "type": "string",
                      "description": "The channel on t.me."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "username",
                    "title",
                    "description",
                    "photoUrl",
                    "verified",
                    "subscribers",
                    "counters",
                    "previewEnabled",
                    "url"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/telegram/channel/posts": {
      "get": {
        "operationId": "telegram_channel_posts",
        "tags": [
          "Telegram"
        ],
        "summary": "Channel posts",
        "description": "A public channel's latest posts, newest first, with text, views, media, links and reactions.\n\nUse it to monitor what a channel publishes and how far each post reaches. About 20 posts per page, newest first.\n\n**Pagination.** Pass the response's `cursor` back as `cursor` for older posts; it's null at the channel's first post.\n\nUnknown channels return 404 `not_found`. Channels with their web preview off return 403 `not_public`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/telegram/channel-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "The channel's username, with or without @ (e.g. `telegram`), or its t.me link.",
            "schema": {
              "description": "The channel's username, with or without @ (e.g. `telegram`), or its t.me link.",
              "type": "string"
            },
            "example": "telegram"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get older posts.",
            "schema": {
              "description": "The `cursor` from the previous response, to get older posts.",
              "type": "string",
              "pattern": "^\\d{1,10}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A public channel's latest posts, newest first, with text, views, media, links and reactions.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number",
                            "description": "Post id, unique within the channel. Posts are numbered in order."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post on t.me, e.g. `https://t.me/telegram/441`."
                          },
                          "channel": {
                            "type": "string",
                            "description": "The channel's username, e.g. `telegram`."
                          },
                          "date": {
                            "description": "Posted at, ISO 8601 (UTC).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "text": {
                            "type": "string",
                            "description": "Post text (or media caption), plain, with line breaks. Empty if the post has none."
                          },
                          "html": {
                            "description": "Post text as HTML: bold, italics, links, quotes. null if the post has no text.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "views": {
                            "description": "View count, as a number. Telegram rounds it (\"1.2K\" → 1200); null if not shown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "viewsText": {
                            "description": "View count as Telegram shows it, e.g. \"1.56M\"; null if not shown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author": {
                            "description": "Author signature, on channels that sign posts; null otherwise.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "edited": {
                            "type": "boolean",
                            "description": "The post was edited after it was published."
                          },
                          "service": {
                            "type": "boolean",
                            "description": "A service message (\"Channel created\", \"Channel photo updated\"), not a real post."
                          },
                          "forwardedFrom": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the channel or person it was forwarded from."
                                  },
                                  "url": {
                                    "description": "Link to the original post or channel; null for hidden accounts.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "name",
                                  "url"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Where the post was forwarded from; null if it's original."
                          },
                          "replyTo": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "description": "Id of the post it replies to; null if the link isn't a post link.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Link to the post it replies to."
                                  },
                                  "author": {
                                    "description": "Name shown on the quoted post.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "text": {
                                    "description": "The quoted post's text, shortened by Telegram; null if it has none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "url",
                                  "author",
                                  "text"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The post this one replies to; null if it isn't a reply."
                          },
                          "thumbnailUrl": {
                            "description": "A preview image for the post: the first media's thumbnail, else the link preview's image; null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "media": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "enum": [
                                    "photo",
                                    "video",
                                    "document",
                                    "audio",
                                    "sticker"
                                  ],
                                  "description": "`photo`, `video`, `document` (a file), `audio` (a music or podcast file) or `sticker`."
                                },
                                "url": {
                                  "description": "Direct file URL on Telegram's CDN, temporary. null for documents, audio, and videos too big for the web preview (open the post instead).",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "thumbnailUrl": {
                                  "description": "Preview image URL (the photo itself for photos), temporary; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "durationS": {
                                  "description": "Video length in seconds; null for other media.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "title": {
                                  "description": "File name or audio title, for documents and audio; null otherwise.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "type",
                                "url",
                                "thumbnailUrl",
                                "durationS",
                                "title"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Photos, videos, files and stickers attached to the post, in order. Empty for text posts."
                          },
                          "linkPreview": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "type": "string",
                                    "description": "The linked page."
                                  },
                                  "siteName": {
                                    "description": "Site name, e.g. \"YouTube\".",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "title": {
                                    "description": "Page title.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "description": {
                                    "description": "Page description.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "imageUrl": {
                                    "description": "Preview image URL, temporary; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "url",
                                  "siteName",
                                  "title",
                                  "description",
                                  "imageUrl"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The link preview card under the text; null if none."
                          },
                          "poll": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "question": {
                                    "type": "string",
                                    "description": "The poll's question."
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "How Telegram labels it, e.g. \"Anonymous Poll\" or \"Quiz\"."
                                  },
                                  "options": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "text": {
                                          "type": "string",
                                          "description": "The option's text."
                                        },
                                        "percent": {
                                          "description": "Share of the votes, a whole percent as Telegram shows it. null from the post endpoint, whose widget hides results.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "text",
                                        "percent"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "The options, in order."
                                  },
                                  "voters": {
                                    "description": "People who voted. Telegram rounds it (\"1.2K\" → 1200). null from the post endpoint, whose widget hides results.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "question",
                                  "type",
                                  "options",
                                  "voters"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The post's poll; null if it has none."
                          },
                          "reactions": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "enum": [
                                    "emoji",
                                    "custom_emoji",
                                    "paid"
                                  ],
                                  "description": "`emoji`, `custom_emoji` (a Premium emoji) or `paid` (Telegram Stars)."
                                },
                                "emoji": {
                                  "description": "The emoji, e.g. \"👍\"; null for paid reactions and custom emoji without a standard look-alike.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "count": {
                                  "type": "number",
                                  "description": "How many, as a number. Telegram rounds large counts (\"14.3K\" → 14300)."
                                }
                              },
                              "required": [
                                "type",
                                "emoji",
                                "count"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Reactions in Telegram's order (paid first, then most frequent). Empty if there are none."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "channel",
                          "date",
                          "text",
                          "html",
                          "views",
                          "viewsText",
                          "author",
                          "edited",
                          "service",
                          "forwardedFrom",
                          "replyTo",
                          "thumbnailUrl",
                          "media",
                          "linkPreview",
                          "poll",
                          "reactions"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of posts, newest first."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for older posts. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/telegram/post": {
      "get": {
        "operationId": "telegram_post",
        "tags": [
          "Telegram"
        ],
        "summary": "Post",
        "description": "One public channel post by link, with text, views, media, links and reactions.\n\nUse it to check one post's reach, or to read a post someone shared. Pass the post's t.me link.\n\nDeleted posts, unknown channels and posts from channels that don't allow embedding return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/telegram/post"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The post's link, e.g. `https://t.me/telegram/441` (t.me/s/… links work too).",
            "schema": {
              "description": "The post's link, e.g. `https://t.me/telegram/441` (t.me/s/… links work too).",
              "type": "string"
            },
            "example": "https://t.me/telegram/441"
          }
        ],
        "responses": {
          "200": {
            "description": "One public channel post by link, with text, views, media, links and reactions.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "number",
                      "description": "Post id, unique within the channel. Posts are numbered in order."
                    },
                    "url": {
                      "type": "string",
                      "description": "The post on t.me, e.g. `https://t.me/telegram/441`."
                    },
                    "channel": {
                      "type": "string",
                      "description": "The channel's username, e.g. `telegram`."
                    },
                    "date": {
                      "description": "Posted at, ISO 8601 (UTC).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "text": {
                      "type": "string",
                      "description": "Post text (or media caption), plain, with line breaks. Empty if the post has none."
                    },
                    "html": {
                      "description": "Post text as HTML: bold, italics, links, quotes. null if the post has no text.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "views": {
                      "description": "View count, as a number. Telegram rounds it (\"1.2K\" → 1200); null if not shown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "viewsText": {
                      "description": "View count as Telegram shows it, e.g. \"1.56M\"; null if not shown.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "author": {
                      "description": "Author signature, on channels that sign posts; null otherwise.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "edited": {
                      "type": "boolean",
                      "description": "The post was edited after it was published."
                    },
                    "service": {
                      "type": "boolean",
                      "description": "A service message (\"Channel created\", \"Channel photo updated\"), not a real post."
                    },
                    "forwardedFrom": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "Name of the channel or person it was forwarded from."
                            },
                            "url": {
                              "description": "Link to the original post or channel; null for hidden accounts.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "name",
                            "url"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Where the post was forwarded from; null if it's original."
                    },
                    "replyTo": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "description": "Id of the post it replies to; null if the link isn't a post link.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "url": {
                              "type": "string",
                              "description": "Link to the post it replies to."
                            },
                            "author": {
                              "description": "Name shown on the quoted post.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "text": {
                              "description": "The quoted post's text, shortened by Telegram; null if it has none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "url",
                            "author",
                            "text"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The post this one replies to; null if it isn't a reply."
                    },
                    "thumbnailUrl": {
                      "description": "A preview image for the post: the first media's thumbnail, else the link preview's image; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "media": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "photo",
                              "video",
                              "document",
                              "audio",
                              "sticker"
                            ],
                            "description": "`photo`, `video`, `document` (a file), `audio` (a music or podcast file) or `sticker`."
                          },
                          "url": {
                            "description": "Direct file URL on Telegram's CDN, temporary. null for documents, audio, and videos too big for the web preview (open the post instead).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnailUrl": {
                            "description": "Preview image URL (the photo itself for photos), temporary; null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "durationS": {
                            "description": "Video length in seconds; null for other media.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "title": {
                            "description": "File name or audio title, for documents and audio; null otherwise.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "url",
                          "thumbnailUrl",
                          "durationS",
                          "title"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Photos, videos, files and stickers attached to the post, in order. Empty for text posts."
                    },
                    "linkPreview": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "url": {
                              "type": "string",
                              "description": "The linked page."
                            },
                            "siteName": {
                              "description": "Site name, e.g. \"YouTube\".",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "title": {
                              "description": "Page title.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "description": {
                              "description": "Page description.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "imageUrl": {
                              "description": "Preview image URL, temporary; null if none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "url",
                            "siteName",
                            "title",
                            "description",
                            "imageUrl"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The link preview card under the text; null if none."
                    },
                    "poll": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "question": {
                              "type": "string",
                              "description": "The poll's question."
                            },
                            "type": {
                              "type": "string",
                              "description": "How Telegram labels it, e.g. \"Anonymous Poll\" or \"Quiz\"."
                            },
                            "options": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "text": {
                                    "type": "string",
                                    "description": "The option's text."
                                  },
                                  "percent": {
                                    "description": "Share of the votes, a whole percent as Telegram shows it. null from the post endpoint, whose widget hides results.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "text",
                                  "percent"
                                ],
                                "additionalProperties": false
                              },
                              "description": "The options, in order."
                            },
                            "voters": {
                              "description": "People who voted. Telegram rounds it (\"1.2K\" → 1200). null from the post endpoint, whose widget hides results.",
                              "type": [
                                "number",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "question",
                            "type",
                            "options",
                            "voters"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The post's poll; null if it has none."
                    },
                    "reactions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "emoji",
                              "custom_emoji",
                              "paid"
                            ],
                            "description": "`emoji`, `custom_emoji` (a Premium emoji) or `paid` (Telegram Stars)."
                          },
                          "emoji": {
                            "description": "The emoji, e.g. \"👍\"; null for paid reactions and custom emoji without a standard look-alike.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "count": {
                            "type": "number",
                            "description": "How many, as a number. Telegram rounds large counts (\"14.3K\" → 14300)."
                          }
                        },
                        "required": [
                          "type",
                          "emoji",
                          "count"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Reactions in Telegram's order (paid first, then most frequent). Empty if there are none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "channel",
                    "date",
                    "text",
                    "html",
                    "views",
                    "viewsText",
                    "author",
                    "edited",
                    "service",
                    "forwardedFrom",
                    "replyTo",
                    "thumbnailUrl",
                    "media",
                    "linkPreview",
                    "poll",
                    "reactions"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/twitter/tweet": {
      "get": {
        "operationId": "twitter_tweet",
        "tags": [
          "X (Twitter)"
        ],
        "summary": "Tweet",
        "description": "One tweet: text, author, likes, replies, reposts, quotes, bookmarks, views, media and the tweet it quotes.\n\nUse it to check how a post performed or to pull its text and media. Pass the tweet's URL (x.com or twitter.com) or its id. Videos come with playable MP4 files in `media[].variants`, best quality first.\n\n`text` is what x.com shows: long posts in full and t.co links expanded. A retweet shows the original's text, media and counts, and `retweeted_tweet` holds the original with its author. For a quote, `quoted_tweet` holds the quoted tweet. `views` is null on tweets from before 2023.\n\nWhen X's main source is busy, we answer from its embed data instead. Then `retweets`, `quotes`, `bookmarks`, `views` and `author.followers` are null, and long posts are cut to 280 characters.\n\nDeleted tweets, tweets from protected accounts and age-restricted tweets return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/twitter/tweet"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The tweet's URL, e.g. `https://x.com/NASA/status/2104593672624886205` (twitter.com links work too), or its numeric id.",
            "schema": {
              "description": "The tweet's URL, e.g. `https://x.com/NASA/status/2104593672624886205` (twitter.com links work too), or its numeric id.",
              "type": "string"
            },
            "example": "https://x.com/NASA/status/2104593672624886205"
          }
        ],
        "responses": {
          "200": {
            "description": "One tweet: text, author, likes, replies, reposts, quotes, bookmarks, views, media and the tweet it quotes.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Tweet id, e.g. `2104593672624886205`."
                    },
                    "url": {
                      "type": "string",
                      "description": "The tweet on x.com."
                    },
                    "text": {
                      "type": "string",
                      "description": "The text as x.com shows it: long posts in full, t.co links expanded, without a reply's leading @mentions or the trailing media link. A retweet shows the original's text. Empty for media-only tweets."
                    },
                    "created_at": {
                      "type": "string",
                      "description": "When it was posted, ISO 8601."
                    },
                    "lang": {
                      "description": "Language as X detects it, e.g. `en` (`und` when it can't tell); null if unknown.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "source": {
                      "description": "The app it was posted from, e.g. `Twitter for iPhone`; null if X doesn't say.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "author": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Numeric user id. It stays the same when the handle changes."
                        },
                        "handle": {
                          "type": "string",
                          "description": "Username (handle), without @."
                        },
                        "name": {
                          "type": "string",
                          "description": "Display name."
                        },
                        "avatar": {
                          "description": "Profile picture URL, 400×400; null if none.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "verified": {
                          "type": "boolean",
                          "description": "Has the blue check (X Premium)."
                        },
                        "verified_type": {
                          "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "followers": {
                          "description": "Followers when fetched; null when X's main source was busy and we used its embed data instead.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "handle",
                        "name",
                        "avatar",
                        "verified",
                        "verified_type",
                        "followers"
                      ],
                      "additionalProperties": false,
                      "description": "Who posted it."
                    },
                    "counts": {
                      "type": "object",
                      "properties": {
                        "likes": {
                          "type": "number",
                          "description": "Likes."
                        },
                        "replies": {
                          "type": "number",
                          "description": "Replies."
                        },
                        "retweets": {
                          "description": "Reposts (retweets); null when X's main source was busy and we used its embed data instead.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "quotes": {
                          "description": "Quote posts; null when X's main source was busy and we used its embed data instead.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "bookmarks": {
                          "description": "Bookmarks; null when X's main source was busy and we used its embed data instead.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "views": {
                          "description": "Views; null on tweets from before 2023 (X didn't count them then), and null when X's main source was busy and we used its embed data instead.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "likes",
                        "replies",
                        "retweets",
                        "quotes",
                        "bookmarks",
                        "views"
                      ],
                      "additionalProperties": false,
                      "description": "Engagement when fetched. Exact numbers, not rounded. A retweet shows the original's, as x.com does."
                    },
                    "media": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "photo",
                              "video",
                              "gif"
                            ],
                            "description": "`photo`, `video` or `gif` (X plays GIFs as silent looping MP4s)."
                          },
                          "url": {
                            "type": "string",
                            "description": "The image; for videos and GIFs, the poster (thumbnail) image."
                          },
                          "width": {
                            "type": "number",
                            "description": "Original width in pixels."
                          },
                          "height": {
                            "type": "number",
                            "description": "Original height in pixels."
                          },
                          "duration_ms": {
                            "description": "Video length in milliseconds; null for photos and GIFs.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "variants": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "File URL on video.twimg.com."
                                },
                                "content_type": {
                                  "type": "string",
                                  "description": "`video/mp4`, or `application/x-mpegURL` for the HLS playlist."
                                },
                                "bitrate": {
                                  "description": "Bits per second; null for the HLS playlist.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "url",
                                "content_type",
                                "bitrate"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Playable files for videos and GIFs: MP4s from highest to lowest bitrate, then the HLS playlist. Empty for photos."
                          }
                        },
                        "required": [
                          "type",
                          "url",
                          "width",
                          "height",
                          "duration_ms",
                          "variants"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Attached photos, videos and GIFs, in order. Empty if none."
                    },
                    "hashtags": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Hashtag without #."
                      },
                      "description": "Hashtags in the text, without #."
                    },
                    "mentions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Username without @."
                      },
                      "description": "Usernames @mentioned, including the ones a reply is addressed to."
                    },
                    "links": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Full URL."
                      },
                      "description": "Links in the text, expanded (not t.co). The tweet's own photos and videos aren't included."
                    },
                    "poll": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "options": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "label": {
                                    "type": "string",
                                    "description": "The choice's text."
                                  },
                                  "votes": {
                                    "description": "Votes for it, exact; null if X doesn't show them.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "label",
                                  "votes"
                                ],
                                "additionalProperties": false
                              },
                              "description": "The choices, in order."
                            },
                            "ends_at": {
                              "description": "When voting ends (or ended), ISO 8601; null if X doesn't say.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "closed": {
                              "type": "boolean",
                              "description": "Voting has ended, so the counts are final."
                            }
                          },
                          "required": [
                            "options",
                            "ends_at",
                            "closed"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The tweet's poll; null if it has none."
                    },
                    "article": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "title": {
                              "type": "string",
                              "description": "The article's title."
                            },
                            "preview_text": {
                              "description": "The opening lines X shows on the article's card; null if none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "text": {
                              "description": "The full body as plain text, blocks separated by blank lines. null in user-tweets, where X sends only the preview.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "cover": {
                              "description": "Cover image URL; null if none.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "title",
                            "preview_text",
                            "text",
                            "cover"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "An X Article (long-form post): title, preview, body and cover. Its tweet's `text` is just the article's link. null for other tweets."
                    },
                    "reply_to_id": {
                      "description": "Id of the tweet this replies to; null if it isn't a reply.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "reply_to_handle": {
                      "description": "Username of the account this replies to; null if it isn't a reply.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "conversation_id": {
                      "description": "Id of the thread's first tweet (its own id if it starts one); null if X doesn't say.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "quoted_id": {
                      "description": "Id of the tweet this one quotes; null if it isn't a quote.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "possibly_sensitive": {
                      "type": "boolean",
                      "description": "X marks the media as possibly sensitive."
                    },
                    "quoted_tweet": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Tweet id, e.g. `2104593672624886205`."
                            },
                            "url": {
                              "type": "string",
                              "description": "The tweet on x.com."
                            },
                            "text": {
                              "type": "string",
                              "description": "The text as x.com shows it: long posts in full, t.co links expanded, without a reply's leading @mentions or the trailing media link. A retweet shows the original's text. Empty for media-only tweets."
                            },
                            "created_at": {
                              "type": "string",
                              "description": "When it was posted, ISO 8601."
                            },
                            "lang": {
                              "description": "Language as X detects it, e.g. `en` (`und` when it can't tell); null if unknown.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "source": {
                              "description": "The app it was posted from, e.g. `Twitter for iPhone`; null if X doesn't say.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "author": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "description": "Numeric user id. It stays the same when the handle changes."
                                },
                                "handle": {
                                  "type": "string",
                                  "description": "Username (handle), without @."
                                },
                                "name": {
                                  "type": "string",
                                  "description": "Display name."
                                },
                                "avatar": {
                                  "description": "Profile picture URL, 400×400; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "verified": {
                                  "type": "boolean",
                                  "description": "Has the blue check (X Premium)."
                                },
                                "verified_type": {
                                  "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "followers": {
                                  "description": "Followers when fetched; null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "id",
                                "handle",
                                "name",
                                "avatar",
                                "verified",
                                "verified_type",
                                "followers"
                              ],
                              "additionalProperties": false,
                              "description": "Who posted it."
                            },
                            "counts": {
                              "type": "object",
                              "properties": {
                                "likes": {
                                  "type": "number",
                                  "description": "Likes."
                                },
                                "replies": {
                                  "type": "number",
                                  "description": "Replies."
                                },
                                "retweets": {
                                  "description": "Reposts (retweets); null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "quotes": {
                                  "description": "Quote posts; null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "bookmarks": {
                                  "description": "Bookmarks; null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "views": {
                                  "description": "Views; null on tweets from before 2023 (X didn't count them then), and null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "likes",
                                "replies",
                                "retweets",
                                "quotes",
                                "bookmarks",
                                "views"
                              ],
                              "additionalProperties": false,
                              "description": "Engagement when fetched. Exact numbers, not rounded. A retweet shows the original's, as x.com does."
                            },
                            "media": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "photo",
                                      "video",
                                      "gif"
                                    ],
                                    "description": "`photo`, `video` or `gif` (X plays GIFs as silent looping MP4s)."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The image; for videos and GIFs, the poster (thumbnail) image."
                                  },
                                  "width": {
                                    "type": "number",
                                    "description": "Original width in pixels."
                                  },
                                  "height": {
                                    "type": "number",
                                    "description": "Original height in pixels."
                                  },
                                  "duration_ms": {
                                    "description": "Video length in milliseconds; null for photos and GIFs.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "variants": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "url": {
                                          "type": "string",
                                          "description": "File URL on video.twimg.com."
                                        },
                                        "content_type": {
                                          "type": "string",
                                          "description": "`video/mp4`, or `application/x-mpegURL` for the HLS playlist."
                                        },
                                        "bitrate": {
                                          "description": "Bits per second; null for the HLS playlist.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "url",
                                        "content_type",
                                        "bitrate"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Playable files for videos and GIFs: MP4s from highest to lowest bitrate, then the HLS playlist. Empty for photos."
                                  }
                                },
                                "required": [
                                  "type",
                                  "url",
                                  "width",
                                  "height",
                                  "duration_ms",
                                  "variants"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Attached photos, videos and GIFs, in order. Empty if none."
                            },
                            "hashtags": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Hashtag without #."
                              },
                              "description": "Hashtags in the text, without #."
                            },
                            "mentions": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Username without @."
                              },
                              "description": "Usernames @mentioned, including the ones a reply is addressed to."
                            },
                            "links": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Full URL."
                              },
                              "description": "Links in the text, expanded (not t.co). The tweet's own photos and videos aren't included."
                            },
                            "poll": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "options": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "label": {
                                            "type": "string",
                                            "description": "The choice's text."
                                          },
                                          "votes": {
                                            "description": "Votes for it, exact; null if X doesn't show them.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "label",
                                          "votes"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The choices, in order."
                                    },
                                    "ends_at": {
                                      "description": "When voting ends (or ended), ISO 8601; null if X doesn't say.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "closed": {
                                      "type": "boolean",
                                      "description": "Voting has ended, so the counts are final."
                                    }
                                  },
                                  "required": [
                                    "options",
                                    "ends_at",
                                    "closed"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The tweet's poll; null if it has none."
                            },
                            "article": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "title": {
                                      "type": "string",
                                      "description": "The article's title."
                                    },
                                    "preview_text": {
                                      "description": "The opening lines X shows on the article's card; null if none.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "text": {
                                      "description": "The full body as plain text, blocks separated by blank lines. null in user-tweets, where X sends only the preview.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "cover": {
                                      "description": "Cover image URL; null if none.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "title",
                                    "preview_text",
                                    "text",
                                    "cover"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "An X Article (long-form post): title, preview, body and cover. Its tweet's `text` is just the article's link. null for other tweets."
                            },
                            "reply_to_id": {
                              "description": "Id of the tweet this replies to; null if it isn't a reply.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "reply_to_handle": {
                              "description": "Username of the account this replies to; null if it isn't a reply.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "conversation_id": {
                              "description": "Id of the thread's first tweet (its own id if it starts one); null if X doesn't say.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "quoted_id": {
                              "description": "Id of the tweet this one quotes; null if it isn't a quote.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "possibly_sensitive": {
                              "type": "boolean",
                              "description": "X marks the media as possibly sensitive."
                            }
                          },
                          "required": [
                            "id",
                            "url",
                            "text",
                            "created_at",
                            "lang",
                            "source",
                            "author",
                            "counts",
                            "media",
                            "hashtags",
                            "mentions",
                            "links",
                            "poll",
                            "article",
                            "reply_to_id",
                            "reply_to_handle",
                            "conversation_id",
                            "quoted_id",
                            "possibly_sensitive"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The tweet this one quotes (without its own quoted or retweeted tweet); null if none or it's no longer available."
                    },
                    "retweeted_tweet": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Tweet id, e.g. `2104593672624886205`."
                            },
                            "url": {
                              "type": "string",
                              "description": "The tweet on x.com."
                            },
                            "text": {
                              "type": "string",
                              "description": "The text as x.com shows it: long posts in full, t.co links expanded, without a reply's leading @mentions or the trailing media link. A retweet shows the original's text. Empty for media-only tweets."
                            },
                            "created_at": {
                              "type": "string",
                              "description": "When it was posted, ISO 8601."
                            },
                            "lang": {
                              "description": "Language as X detects it, e.g. `en` (`und` when it can't tell); null if unknown.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "source": {
                              "description": "The app it was posted from, e.g. `Twitter for iPhone`; null if X doesn't say.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "author": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "description": "Numeric user id. It stays the same when the handle changes."
                                },
                                "handle": {
                                  "type": "string",
                                  "description": "Username (handle), without @."
                                },
                                "name": {
                                  "type": "string",
                                  "description": "Display name."
                                },
                                "avatar": {
                                  "description": "Profile picture URL, 400×400; null if none.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "verified": {
                                  "type": "boolean",
                                  "description": "Has the blue check (X Premium)."
                                },
                                "verified_type": {
                                  "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "followers": {
                                  "description": "Followers when fetched; null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "id",
                                "handle",
                                "name",
                                "avatar",
                                "verified",
                                "verified_type",
                                "followers"
                              ],
                              "additionalProperties": false,
                              "description": "Who posted it."
                            },
                            "counts": {
                              "type": "object",
                              "properties": {
                                "likes": {
                                  "type": "number",
                                  "description": "Likes."
                                },
                                "replies": {
                                  "type": "number",
                                  "description": "Replies."
                                },
                                "retweets": {
                                  "description": "Reposts (retweets); null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "quotes": {
                                  "description": "Quote posts; null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "bookmarks": {
                                  "description": "Bookmarks; null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "views": {
                                  "description": "Views; null on tweets from before 2023 (X didn't count them then), and null when X's main source was busy and we used its embed data instead.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "likes",
                                "replies",
                                "retweets",
                                "quotes",
                                "bookmarks",
                                "views"
                              ],
                              "additionalProperties": false,
                              "description": "Engagement when fetched. Exact numbers, not rounded. A retweet shows the original's, as x.com does."
                            },
                            "media": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "photo",
                                      "video",
                                      "gif"
                                    ],
                                    "description": "`photo`, `video` or `gif` (X plays GIFs as silent looping MP4s)."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The image; for videos and GIFs, the poster (thumbnail) image."
                                  },
                                  "width": {
                                    "type": "number",
                                    "description": "Original width in pixels."
                                  },
                                  "height": {
                                    "type": "number",
                                    "description": "Original height in pixels."
                                  },
                                  "duration_ms": {
                                    "description": "Video length in milliseconds; null for photos and GIFs.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "variants": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "url": {
                                          "type": "string",
                                          "description": "File URL on video.twimg.com."
                                        },
                                        "content_type": {
                                          "type": "string",
                                          "description": "`video/mp4`, or `application/x-mpegURL` for the HLS playlist."
                                        },
                                        "bitrate": {
                                          "description": "Bits per second; null for the HLS playlist.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "url",
                                        "content_type",
                                        "bitrate"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Playable files for videos and GIFs: MP4s from highest to lowest bitrate, then the HLS playlist. Empty for photos."
                                  }
                                },
                                "required": [
                                  "type",
                                  "url",
                                  "width",
                                  "height",
                                  "duration_ms",
                                  "variants"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Attached photos, videos and GIFs, in order. Empty if none."
                            },
                            "hashtags": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Hashtag without #."
                              },
                              "description": "Hashtags in the text, without #."
                            },
                            "mentions": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Username without @."
                              },
                              "description": "Usernames @mentioned, including the ones a reply is addressed to."
                            },
                            "links": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Full URL."
                              },
                              "description": "Links in the text, expanded (not t.co). The tweet's own photos and videos aren't included."
                            },
                            "poll": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "options": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "label": {
                                            "type": "string",
                                            "description": "The choice's text."
                                          },
                                          "votes": {
                                            "description": "Votes for it, exact; null if X doesn't show them.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "label",
                                          "votes"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The choices, in order."
                                    },
                                    "ends_at": {
                                      "description": "When voting ends (or ended), ISO 8601; null if X doesn't say.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "closed": {
                                      "type": "boolean",
                                      "description": "Voting has ended, so the counts are final."
                                    }
                                  },
                                  "required": [
                                    "options",
                                    "ends_at",
                                    "closed"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The tweet's poll; null if it has none."
                            },
                            "article": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "title": {
                                      "type": "string",
                                      "description": "The article's title."
                                    },
                                    "preview_text": {
                                      "description": "The opening lines X shows on the article's card; null if none.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "text": {
                                      "description": "The full body as plain text, blocks separated by blank lines. null in user-tweets, where X sends only the preview.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "cover": {
                                      "description": "Cover image URL; null if none.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "title",
                                    "preview_text",
                                    "text",
                                    "cover"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "An X Article (long-form post): title, preview, body and cover. Its tweet's `text` is just the article's link. null for other tweets."
                            },
                            "reply_to_id": {
                              "description": "Id of the tweet this replies to; null if it isn't a reply.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "reply_to_handle": {
                              "description": "Username of the account this replies to; null if it isn't a reply.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "conversation_id": {
                              "description": "Id of the thread's first tweet (its own id if it starts one); null if X doesn't say.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "quoted_id": {
                              "description": "Id of the tweet this one quotes; null if it isn't a quote.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "possibly_sensitive": {
                              "type": "boolean",
                              "description": "X marks the media as possibly sensitive."
                            }
                          },
                          "required": [
                            "id",
                            "url",
                            "text",
                            "created_at",
                            "lang",
                            "source",
                            "author",
                            "counts",
                            "media",
                            "hashtags",
                            "mentions",
                            "links",
                            "poll",
                            "article",
                            "reply_to_id",
                            "reply_to_handle",
                            "conversation_id",
                            "quoted_id",
                            "possibly_sensitive"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "For retweets: the original tweet and its author. The retweet's own text, media, links and counts mirror it (as on x.com); its id, author and `created_at` are the retweet's. null for everything else."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "text",
                    "created_at",
                    "lang",
                    "source",
                    "author",
                    "counts",
                    "media",
                    "hashtags",
                    "mentions",
                    "links",
                    "poll",
                    "article",
                    "reply_to_id",
                    "reply_to_handle",
                    "conversation_id",
                    "quoted_id",
                    "possibly_sensitive",
                    "quoted_tweet",
                    "retweeted_tweet"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/twitter/profile": {
      "get": {
        "operationId": "twitter_profile",
        "tags": [
          "X (Twitter)"
        ],
        "summary": "Profile",
        "description": "An account's bio, avatar, verification and exact follower, following, tweet and like counts.\n\nUse it to size up an account: followers, following, tweets and likes as exact numbers, plus bio, website, location, join date and verification. `verified` is the blue check; `verified_type` shows gold (`Business`) and grey (`Government`) checks. Pass a `pinned_tweet_ids` entry to the tweet endpoint for the pinned tweet.\n\nProtected accounts return their profile with `protected: true`. Unknown and suspended accounts return 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/twitter/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "X username, with or without @ (e.g. `NASA`), or the profile URL.",
            "schema": {
              "description": "X username, with or without @ (e.g. `NASA`), or the profile URL.",
              "type": "string"
            },
            "example": "NASA"
          }
        ],
        "responses": {
          "200": {
            "description": "An account's bio, avatar, verification and exact follower, following, tweet and like counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Numeric user id. It stays the same when the handle changes."
                    },
                    "handle": {
                      "type": "string",
                      "description": "Username (handle), without @, with X's capitalization."
                    },
                    "name": {
                      "type": "string",
                      "description": "Display name."
                    },
                    "bio": {
                      "type": "string",
                      "description": "Bio text, t.co links expanded. Empty if none."
                    },
                    "location": {
                      "description": "Location as the account wrote it (free text); null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "website": {
                      "description": "The website link on the profile, expanded; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "avatar": {
                      "description": "Profile picture URL, 400×400; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "banner": {
                      "description": "Header image URL; null if none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "verified": {
                      "type": "boolean",
                      "description": "Has the blue check (X Premium)."
                    },
                    "verified_type": {
                      "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "created_at": {
                      "type": "string",
                      "description": "When the account was created, ISO 8601."
                    },
                    "followers": {
                      "type": "number",
                      "description": "Followers, exact."
                    },
                    "following": {
                      "type": "number",
                      "description": "Accounts they follow."
                    },
                    "tweets": {
                      "type": "number",
                      "description": "Tweets posted, replies and retweets included."
                    },
                    "media_count": {
                      "type": "number",
                      "description": "Tweets with photos or videos."
                    },
                    "likes": {
                      "type": "number",
                      "description": "Tweets they liked."
                    },
                    "pinned_tweet_ids": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Tweet id."
                      },
                      "description": "Ids of the pinned tweet(s); pass one to the tweet endpoint. Empty if none."
                    },
                    "protected": {
                      "type": "boolean",
                      "description": "A protected (private) account: only approved followers see its tweets."
                    },
                    "professional_type": {
                      "description": "`Creator` or `Business` for professional accounts; null for personal ones.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "handle",
                    "name",
                    "bio",
                    "location",
                    "website",
                    "avatar",
                    "banner",
                    "verified",
                    "verified_type",
                    "created_at",
                    "followers",
                    "following",
                    "tweets",
                    "media_count",
                    "likes",
                    "pinned_tweet_ids",
                    "protected",
                    "professional_type"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/twitter/user-tweets": {
      "get": {
        "operationId": "twitter_user_tweets",
        "tags": [
          "X (Twitter)"
        ],
        "summary": "User tweets",
        "description": "An account's tweets and retweets, about 20 per page, with text, media and engagement counts.\n\nUse it to audit what an account posts and how each post does. Retweets are included, showing the original's text, media and counts (the original and its author are in `retweeted_tweet`). Replies aren't, except the account's own threads. On the first page the pinned tweet comes first, with `pinned: true`.\n\n**Ordering.** Check `ordering`. For most accounts it's `chronological`: newest first, with more pages. For some very large accounts X shows logged-out visitors only a `ranked` sample instead: about 100 popular tweets from all years, in X's order, with no next page.\n\n**Pagination.** Pass the response's `cursor` back as `cursor` (with the same `handle`) for older tweets; it's null at the end.\n\nUnknown and suspended accounts return 404 `not_found`, and so do protected accounts, whose tweets need a login.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/twitter/user-tweets"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "X username, with or without @ (e.g. `NASA`), or the profile URL.",
            "schema": {
              "description": "X username, with or without @ (e.g. `NASA`), or the profile URL.",
              "type": "string"
            },
            "example": "NASA"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, to get older tweets.",
            "schema": {
              "description": "The `cursor` from the previous response, to get older tweets.",
              "type": "string",
              "minLength": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An account's tweets and retweets, about 20 per page, with text, media and engagement counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "tweets": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Tweet id, e.g. `2104593672624886205`."
                          },
                          "url": {
                            "type": "string",
                            "description": "The tweet on x.com."
                          },
                          "text": {
                            "type": "string",
                            "description": "The text as x.com shows it: long posts in full, t.co links expanded, without a reply's leading @mentions or the trailing media link. A retweet shows the original's text. Empty for media-only tweets."
                          },
                          "created_at": {
                            "type": "string",
                            "description": "When it was posted, ISO 8601."
                          },
                          "lang": {
                            "description": "Language as X detects it, e.g. `en` (`und` when it can't tell); null if unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "source": {
                            "description": "The app it was posted from, e.g. `Twitter for iPhone`; null if X doesn't say.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "author": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Numeric user id. It stays the same when the handle changes."
                              },
                              "handle": {
                                "type": "string",
                                "description": "Username (handle), without @."
                              },
                              "name": {
                                "type": "string",
                                "description": "Display name."
                              },
                              "avatar": {
                                "description": "Profile picture URL, 400×400; null if none.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Has the blue check (X Premium)."
                              },
                              "verified_type": {
                                "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "followers": {
                                "description": "Followers when fetched; null when X's main source was busy and we used its embed data instead.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "id",
                              "handle",
                              "name",
                              "avatar",
                              "verified",
                              "verified_type",
                              "followers"
                            ],
                            "additionalProperties": false,
                            "description": "Who posted it."
                          },
                          "counts": {
                            "type": "object",
                            "properties": {
                              "likes": {
                                "type": "number",
                                "description": "Likes."
                              },
                              "replies": {
                                "type": "number",
                                "description": "Replies."
                              },
                              "retweets": {
                                "description": "Reposts (retweets); null when X's main source was busy and we used its embed data instead.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "quotes": {
                                "description": "Quote posts; null when X's main source was busy and we used its embed data instead.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "bookmarks": {
                                "description": "Bookmarks; null when X's main source was busy and we used its embed data instead.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "views": {
                                "description": "Views; null on tweets from before 2023 (X didn't count them then), and null when X's main source was busy and we used its embed data instead.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "likes",
                              "replies",
                              "retweets",
                              "quotes",
                              "bookmarks",
                              "views"
                            ],
                            "additionalProperties": false,
                            "description": "Engagement when fetched. Exact numbers, not rounded. A retweet shows the original's, as x.com does."
                          },
                          "media": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "enum": [
                                    "photo",
                                    "video",
                                    "gif"
                                  ],
                                  "description": "`photo`, `video` or `gif` (X plays GIFs as silent looping MP4s)."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "The image; for videos and GIFs, the poster (thumbnail) image."
                                },
                                "width": {
                                  "type": "number",
                                  "description": "Original width in pixels."
                                },
                                "height": {
                                  "type": "number",
                                  "description": "Original height in pixels."
                                },
                                "duration_ms": {
                                  "description": "Video length in milliseconds; null for photos and GIFs.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "variants": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "url": {
                                        "type": "string",
                                        "description": "File URL on video.twimg.com."
                                      },
                                      "content_type": {
                                        "type": "string",
                                        "description": "`video/mp4`, or `application/x-mpegURL` for the HLS playlist."
                                      },
                                      "bitrate": {
                                        "description": "Bits per second; null for the HLS playlist.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "url",
                                      "content_type",
                                      "bitrate"
                                    ],
                                    "additionalProperties": false
                                  },
                                  "description": "Playable files for videos and GIFs: MP4s from highest to lowest bitrate, then the HLS playlist. Empty for photos."
                                }
                              },
                              "required": [
                                "type",
                                "url",
                                "width",
                                "height",
                                "duration_ms",
                                "variants"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Attached photos, videos and GIFs, in order. Empty if none."
                          },
                          "hashtags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Hashtag without #."
                            },
                            "description": "Hashtags in the text, without #."
                          },
                          "mentions": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Username without @."
                            },
                            "description": "Usernames @mentioned, including the ones a reply is addressed to."
                          },
                          "links": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "description": "Full URL."
                            },
                            "description": "Links in the text, expanded (not t.co). The tweet's own photos and videos aren't included."
                          },
                          "poll": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "options": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "label": {
                                          "type": "string",
                                          "description": "The choice's text."
                                        },
                                        "votes": {
                                          "description": "Votes for it, exact; null if X doesn't show them.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "label",
                                        "votes"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "The choices, in order."
                                  },
                                  "ends_at": {
                                    "description": "When voting ends (or ended), ISO 8601; null if X doesn't say.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "closed": {
                                    "type": "boolean",
                                    "description": "Voting has ended, so the counts are final."
                                  }
                                },
                                "required": [
                                  "options",
                                  "ends_at",
                                  "closed"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The tweet's poll; null if it has none."
                          },
                          "article": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "title": {
                                    "type": "string",
                                    "description": "The article's title."
                                  },
                                  "preview_text": {
                                    "description": "The opening lines X shows on the article's card; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "text": {
                                    "description": "The full body as plain text, blocks separated by blank lines. null in user-tweets, where X sends only the preview.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "cover": {
                                    "description": "Cover image URL; null if none.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "title",
                                  "preview_text",
                                  "text",
                                  "cover"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "An X Article (long-form post): title, preview, body and cover. Its tweet's `text` is just the article's link. null for other tweets."
                          },
                          "reply_to_id": {
                            "description": "Id of the tweet this replies to; null if it isn't a reply.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "reply_to_handle": {
                            "description": "Username of the account this replies to; null if it isn't a reply.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "conversation_id": {
                            "description": "Id of the thread's first tweet (its own id if it starts one); null if X doesn't say.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "quoted_id": {
                            "description": "Id of the tweet this one quotes; null if it isn't a quote.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "possibly_sensitive": {
                            "type": "boolean",
                            "description": "X marks the media as possibly sensitive."
                          },
                          "quoted_tweet": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Tweet id, e.g. `2104593672624886205`."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The tweet on x.com."
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "The text as x.com shows it: long posts in full, t.co links expanded, without a reply's leading @mentions or the trailing media link. A retweet shows the original's text. Empty for media-only tweets."
                                  },
                                  "created_at": {
                                    "type": "string",
                                    "description": "When it was posted, ISO 8601."
                                  },
                                  "lang": {
                                    "description": "Language as X detects it, e.g. `en` (`und` when it can't tell); null if unknown.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "source": {
                                    "description": "The app it was posted from, e.g. `Twitter for iPhone`; null if X doesn't say.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "author": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "string",
                                        "description": "Numeric user id. It stays the same when the handle changes."
                                      },
                                      "handle": {
                                        "type": "string",
                                        "description": "Username (handle), without @."
                                      },
                                      "name": {
                                        "type": "string",
                                        "description": "Display name."
                                      },
                                      "avatar": {
                                        "description": "Profile picture URL, 400×400; null if none.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "verified": {
                                        "type": "boolean",
                                        "description": "Has the blue check (X Premium)."
                                      },
                                      "verified_type": {
                                        "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "followers": {
                                        "description": "Followers when fetched; null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "handle",
                                      "name",
                                      "avatar",
                                      "verified",
                                      "verified_type",
                                      "followers"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Who posted it."
                                  },
                                  "counts": {
                                    "type": "object",
                                    "properties": {
                                      "likes": {
                                        "type": "number",
                                        "description": "Likes."
                                      },
                                      "replies": {
                                        "type": "number",
                                        "description": "Replies."
                                      },
                                      "retweets": {
                                        "description": "Reposts (retweets); null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "quotes": {
                                        "description": "Quote posts; null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "bookmarks": {
                                        "description": "Bookmarks; null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "views": {
                                        "description": "Views; null on tweets from before 2023 (X didn't count them then), and null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "likes",
                                      "replies",
                                      "retweets",
                                      "quotes",
                                      "bookmarks",
                                      "views"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Engagement when fetched. Exact numbers, not rounded. A retweet shows the original's, as x.com does."
                                  },
                                  "media": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "type": {
                                          "type": "string",
                                          "enum": [
                                            "photo",
                                            "video",
                                            "gif"
                                          ],
                                          "description": "`photo`, `video` or `gif` (X plays GIFs as silent looping MP4s)."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "The image; for videos and GIFs, the poster (thumbnail) image."
                                        },
                                        "width": {
                                          "type": "number",
                                          "description": "Original width in pixels."
                                        },
                                        "height": {
                                          "type": "number",
                                          "description": "Original height in pixels."
                                        },
                                        "duration_ms": {
                                          "description": "Video length in milliseconds; null for photos and GIFs.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        },
                                        "variants": {
                                          "type": "array",
                                          "items": {
                                            "type": "object",
                                            "properties": {
                                              "url": {
                                                "type": "string",
                                                "description": "File URL on video.twimg.com."
                                              },
                                              "content_type": {
                                                "type": "string",
                                                "description": "`video/mp4`, or `application/x-mpegURL` for the HLS playlist."
                                              },
                                              "bitrate": {
                                                "description": "Bits per second; null for the HLS playlist.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "url",
                                              "content_type",
                                              "bitrate"
                                            ],
                                            "additionalProperties": false
                                          },
                                          "description": "Playable files for videos and GIFs: MP4s from highest to lowest bitrate, then the HLS playlist. Empty for photos."
                                        }
                                      },
                                      "required": [
                                        "type",
                                        "url",
                                        "width",
                                        "height",
                                        "duration_ms",
                                        "variants"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Attached photos, videos and GIFs, in order. Empty if none."
                                  },
                                  "hashtags": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "description": "Hashtag without #."
                                    },
                                    "description": "Hashtags in the text, without #."
                                  },
                                  "mentions": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "description": "Username without @."
                                    },
                                    "description": "Usernames @mentioned, including the ones a reply is addressed to."
                                  },
                                  "links": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "description": "Full URL."
                                    },
                                    "description": "Links in the text, expanded (not t.co). The tweet's own photos and videos aren't included."
                                  },
                                  "poll": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "options": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "properties": {
                                                "label": {
                                                  "type": "string",
                                                  "description": "The choice's text."
                                                },
                                                "votes": {
                                                  "description": "Votes for it, exact; null if X doesn't show them.",
                                                  "type": [
                                                    "number",
                                                    "null"
                                                  ]
                                                }
                                              },
                                              "required": [
                                                "label",
                                                "votes"
                                              ],
                                              "additionalProperties": false
                                            },
                                            "description": "The choices, in order."
                                          },
                                          "ends_at": {
                                            "description": "When voting ends (or ended), ISO 8601; null if X doesn't say.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "closed": {
                                            "type": "boolean",
                                            "description": "Voting has ended, so the counts are final."
                                          }
                                        },
                                        "required": [
                                          "options",
                                          "ends_at",
                                          "closed"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The tweet's poll; null if it has none."
                                  },
                                  "article": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "type": "string",
                                            "description": "The article's title."
                                          },
                                          "preview_text": {
                                            "description": "The opening lines X shows on the article's card; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "text": {
                                            "description": "The full body as plain text, blocks separated by blank lines. null in user-tweets, where X sends only the preview.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "cover": {
                                            "description": "Cover image URL; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "title",
                                          "preview_text",
                                          "text",
                                          "cover"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "An X Article (long-form post): title, preview, body and cover. Its tweet's `text` is just the article's link. null for other tweets."
                                  },
                                  "reply_to_id": {
                                    "description": "Id of the tweet this replies to; null if it isn't a reply.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "reply_to_handle": {
                                    "description": "Username of the account this replies to; null if it isn't a reply.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "conversation_id": {
                                    "description": "Id of the thread's first tweet (its own id if it starts one); null if X doesn't say.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "quoted_id": {
                                    "description": "Id of the tweet this one quotes; null if it isn't a quote.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "possibly_sensitive": {
                                    "type": "boolean",
                                    "description": "X marks the media as possibly sensitive."
                                  }
                                },
                                "required": [
                                  "id",
                                  "url",
                                  "text",
                                  "created_at",
                                  "lang",
                                  "source",
                                  "author",
                                  "counts",
                                  "media",
                                  "hashtags",
                                  "mentions",
                                  "links",
                                  "poll",
                                  "article",
                                  "reply_to_id",
                                  "reply_to_handle",
                                  "conversation_id",
                                  "quoted_id",
                                  "possibly_sensitive"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The tweet this one quotes (without its own quoted or retweeted tweet); null if none or it's no longer available."
                          },
                          "retweeted_tweet": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Tweet id, e.g. `2104593672624886205`."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The tweet on x.com."
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "The text as x.com shows it: long posts in full, t.co links expanded, without a reply's leading @mentions or the trailing media link. A retweet shows the original's text. Empty for media-only tweets."
                                  },
                                  "created_at": {
                                    "type": "string",
                                    "description": "When it was posted, ISO 8601."
                                  },
                                  "lang": {
                                    "description": "Language as X detects it, e.g. `en` (`und` when it can't tell); null if unknown.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "source": {
                                    "description": "The app it was posted from, e.g. `Twitter for iPhone`; null if X doesn't say.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "author": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "string",
                                        "description": "Numeric user id. It stays the same when the handle changes."
                                      },
                                      "handle": {
                                        "type": "string",
                                        "description": "Username (handle), without @."
                                      },
                                      "name": {
                                        "type": "string",
                                        "description": "Display name."
                                      },
                                      "avatar": {
                                        "description": "Profile picture URL, 400×400; null if none.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "verified": {
                                        "type": "boolean",
                                        "description": "Has the blue check (X Premium)."
                                      },
                                      "verified_type": {
                                        "description": "`Business` (gold check, a verified organization) or `Government` (grey check); null otherwise.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "followers": {
                                        "description": "Followers when fetched; null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "handle",
                                      "name",
                                      "avatar",
                                      "verified",
                                      "verified_type",
                                      "followers"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Who posted it."
                                  },
                                  "counts": {
                                    "type": "object",
                                    "properties": {
                                      "likes": {
                                        "type": "number",
                                        "description": "Likes."
                                      },
                                      "replies": {
                                        "type": "number",
                                        "description": "Replies."
                                      },
                                      "retweets": {
                                        "description": "Reposts (retweets); null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "quotes": {
                                        "description": "Quote posts; null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "bookmarks": {
                                        "description": "Bookmarks; null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "views": {
                                        "description": "Views; null on tweets from before 2023 (X didn't count them then), and null when X's main source was busy and we used its embed data instead.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "likes",
                                      "replies",
                                      "retweets",
                                      "quotes",
                                      "bookmarks",
                                      "views"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Engagement when fetched. Exact numbers, not rounded. A retweet shows the original's, as x.com does."
                                  },
                                  "media": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "type": {
                                          "type": "string",
                                          "enum": [
                                            "photo",
                                            "video",
                                            "gif"
                                          ],
                                          "description": "`photo`, `video` or `gif` (X plays GIFs as silent looping MP4s)."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "The image; for videos and GIFs, the poster (thumbnail) image."
                                        },
                                        "width": {
                                          "type": "number",
                                          "description": "Original width in pixels."
                                        },
                                        "height": {
                                          "type": "number",
                                          "description": "Original height in pixels."
                                        },
                                        "duration_ms": {
                                          "description": "Video length in milliseconds; null for photos and GIFs.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        },
                                        "variants": {
                                          "type": "array",
                                          "items": {
                                            "type": "object",
                                            "properties": {
                                              "url": {
                                                "type": "string",
                                                "description": "File URL on video.twimg.com."
                                              },
                                              "content_type": {
                                                "type": "string",
                                                "description": "`video/mp4`, or `application/x-mpegURL` for the HLS playlist."
                                              },
                                              "bitrate": {
                                                "description": "Bits per second; null for the HLS playlist.",
                                                "type": [
                                                  "number",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "url",
                                              "content_type",
                                              "bitrate"
                                            ],
                                            "additionalProperties": false
                                          },
                                          "description": "Playable files for videos and GIFs: MP4s from highest to lowest bitrate, then the HLS playlist. Empty for photos."
                                        }
                                      },
                                      "required": [
                                        "type",
                                        "url",
                                        "width",
                                        "height",
                                        "duration_ms",
                                        "variants"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Attached photos, videos and GIFs, in order. Empty if none."
                                  },
                                  "hashtags": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "description": "Hashtag without #."
                                    },
                                    "description": "Hashtags in the text, without #."
                                  },
                                  "mentions": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "description": "Username without @."
                                    },
                                    "description": "Usernames @mentioned, including the ones a reply is addressed to."
                                  },
                                  "links": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "description": "Full URL."
                                    },
                                    "description": "Links in the text, expanded (not t.co). The tweet's own photos and videos aren't included."
                                  },
                                  "poll": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "options": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "properties": {
                                                "label": {
                                                  "type": "string",
                                                  "description": "The choice's text."
                                                },
                                                "votes": {
                                                  "description": "Votes for it, exact; null if X doesn't show them.",
                                                  "type": [
                                                    "number",
                                                    "null"
                                                  ]
                                                }
                                              },
                                              "required": [
                                                "label",
                                                "votes"
                                              ],
                                              "additionalProperties": false
                                            },
                                            "description": "The choices, in order."
                                          },
                                          "ends_at": {
                                            "description": "When voting ends (or ended), ISO 8601; null if X doesn't say.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "closed": {
                                            "type": "boolean",
                                            "description": "Voting has ended, so the counts are final."
                                          }
                                        },
                                        "required": [
                                          "options",
                                          "ends_at",
                                          "closed"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The tweet's poll; null if it has none."
                                  },
                                  "article": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "type": "string",
                                            "description": "The article's title."
                                          },
                                          "preview_text": {
                                            "description": "The opening lines X shows on the article's card; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "text": {
                                            "description": "The full body as plain text, blocks separated by blank lines. null in user-tweets, where X sends only the preview.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "cover": {
                                            "description": "Cover image URL; null if none.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "title",
                                          "preview_text",
                                          "text",
                                          "cover"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "An X Article (long-form post): title, preview, body and cover. Its tweet's `text` is just the article's link. null for other tweets."
                                  },
                                  "reply_to_id": {
                                    "description": "Id of the tweet this replies to; null if it isn't a reply.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "reply_to_handle": {
                                    "description": "Username of the account this replies to; null if it isn't a reply.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "conversation_id": {
                                    "description": "Id of the thread's first tweet (its own id if it starts one); null if X doesn't say.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "quoted_id": {
                                    "description": "Id of the tweet this one quotes; null if it isn't a quote.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "possibly_sensitive": {
                                    "type": "boolean",
                                    "description": "X marks the media as possibly sensitive."
                                  }
                                },
                                "required": [
                                  "id",
                                  "url",
                                  "text",
                                  "created_at",
                                  "lang",
                                  "source",
                                  "author",
                                  "counts",
                                  "media",
                                  "hashtags",
                                  "mentions",
                                  "links",
                                  "poll",
                                  "article",
                                  "reply_to_id",
                                  "reply_to_handle",
                                  "conversation_id",
                                  "quoted_id",
                                  "possibly_sensitive"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "For retweets: the original tweet and its author. The retweet's own text, media, links and counts mirror it (as on x.com); its id, author and `created_at` are the retweet's. null for everything else."
                          },
                          "pinned": {
                            "type": "boolean",
                            "description": "The account's pinned tweet, shown first."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "text",
                          "created_at",
                          "lang",
                          "source",
                          "author",
                          "counts",
                          "media",
                          "hashtags",
                          "mentions",
                          "links",
                          "poll",
                          "article",
                          "reply_to_id",
                          "reply_to_handle",
                          "conversation_id",
                          "quoted_id",
                          "possibly_sensitive",
                          "quoted_tweet",
                          "retweeted_tweet",
                          "pinned"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of tweets and retweets, in `ordering` order."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page; null on the last page and for `ranked` results.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "ordering": {
                      "type": "string",
                      "enum": [
                        "chronological",
                        "ranked"
                      ],
                      "description": "`chronological`: newest first, with more pages. `ranked`: X shows logged-out visitors of this very large account only about 100 popular tweets from all years, with no next page."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "tweets",
                    "cursor",
                    "ordering"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/threads/profile": {
      "get": {
        "operationId": "threads_profile",
        "tags": [
          "Threads"
        ],
        "summary": "Threads profile",
        "description": "A public account's bio, links, follower count, and whether it's verified or private.\n\nUse it to look up a Threads account: name, bio, links, follower count and whether it's verified or private. Pass a username or profile URL as `handle`.\n\nA private account still shows its profile, so check `is_private` before asking for its posts. An unknown account returns 404 `not_found`. If Threads sends back an incomplete page, the call fails with `upstream_error`, which is free.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/threads/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Threads username, with or without @ (e.g. `zuck`), or the profile's threads.com or threads.net URL.",
            "schema": {
              "description": "Threads username, with or without @ (e.g. `zuck`), or the profile's threads.com or threads.net URL.",
              "type": "string"
            },
            "example": "zuck"
          }
        ],
        "responses": {
          "200": {
            "description": "A public account's bio, links, follower count, and whether it's verified or private.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Numeric Threads account id, as a string."
                    },
                    "username": {
                      "type": "string",
                      "description": "Account username without @."
                    },
                    "name": {
                      "description": "Display name; null when unknown.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "biography": {
                      "description": "The profile's bio; null when it has none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "followers_count": {
                      "description": "Follower count; null when Threads doesn't show it.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "is_verified": {
                      "description": "Whether the profile has a verified badge; null when unknown.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "is_private": {
                      "description": "Whether Threads marks the profile private; null when it doesn't say.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "profile_pic_url": {
                      "description": "Profile picture URL, largest size; null when missing.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "bio_links": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string",
                            "description": "Where the link goes."
                          },
                          "title": {
                            "description": "The link's title; null when it has none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "url",
                          "title"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Links in the bio, in order."
                    },
                    "url": {
                      "type": "string",
                      "description": "The profile's URL on threads.com."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "username",
                    "name",
                    "biography",
                    "followers_count",
                    "is_verified",
                    "is_private",
                    "profile_pic_url",
                    "bio_links",
                    "url"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/threads/user/posts": {
      "get": {
        "operationId": "threads_user_posts",
        "tags": [
          "Threads"
        ],
        "summary": "Threads account posts",
        "description": "One page of a public account's Threads posts, with text, media and engagement.\n\nUse it to follow what an account posts, with each post's likes, replies, reposts and quotes. Pass a username or profile URL as `handle`.\n\nPosts come in the account's feed order, and pinned posts can come before newer ones. When the author replied to their own post, those replies come along. `count` counts these threads, not single posts, so a page can hold more posts than `count`.\n\n**Pagination.** Pass `next_cursor` back as `cursor` with the same handle. It's null on the last page.\n\nAn unknown account returns 404 `not_found`, and a private one 403 `not_public`. If Threads sends back an incomplete page, the call fails with `upstream_error` (free) rather than returning an empty list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/threads/user-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Threads username, with or without @ (e.g. `zuck`), or the profile's threads.com or threads.net URL.",
            "schema": {
              "description": "Threads username, with or without @ (e.g. `zuck`), or the profile's threads.com or threads.net URL.",
              "type": "string"
            },
            "example": "zuck"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `next_cursor` from the previous response. Keep the same `handle`.",
            "schema": {
              "description": "The `next_cursor` from the previous response. Keep the same `handle`.",
              "type": "string",
              "minLength": 1,
              "maxLength": 2048
            }
          },
          {
            "name": "count",
            "in": "query",
            "required": false,
            "description": "How many threads to ask for, 1–20 (default 10). One thread can hold several posts when the author replied to themselves.",
            "schema": {
              "default": 10,
              "description": "How many threads to ask for, 1–20 (default 10). One thread can hold several posts when the author replied to themselves.",
              "type": "integer",
              "minimum": 1,
              "maximum": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One page of a public account's Threads posts, with text, media and engagement.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Numeric Threads post id, as a string."
                          },
                          "code": {
                            "type": "string",
                            "description": "The post's shortcode, as in its URL."
                          },
                          "url": {
                            "type": "string",
                            "description": "The post's URL on threads.com."
                          },
                          "text": {
                            "type": "string",
                            "description": "Post text; empty for posts that contain only media."
                          },
                          "created_at": {
                            "description": "When it was posted, ISO 8601; null when unknown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "like_count": {
                            "description": "Likes; null when Threads doesn't show the count.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "reply_count": {
                            "description": "Direct replies; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "repost_count": {
                            "description": "Reposts; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "quote_count": {
                            "description": "Quote posts; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "author": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Numeric Threads account id, as a string."
                                  },
                                  "username": {
                                    "type": "string",
                                    "description": "Account username without @."
                                  },
                                  "name": {
                                    "description": "Display name; null when the public post omits it.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "is_verified": {
                                    "description": "Whether the author has a verified badge; null when unknown.",
                                    "type": [
                                      "boolean",
                                      "null"
                                    ]
                                  },
                                  "profile_pic_url": {
                                    "description": "Profile picture URL; null when the public post omits it.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "username",
                                  "name",
                                  "is_verified",
                                  "profile_pic_url"
                                ],
                                "additionalProperties": false,
                                "description": "Who posted it; null when Threads doesn't say."
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "media": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "enum": [
                                    "image",
                                    "video"
                                  ],
                                  "description": "Whether the URL is an image or a playable video file."
                                },
                                "url": {
                                  "type": "string",
                                  "description": "The largest image or video file Threads offers. The link can expire."
                                },
                                "width": {
                                  "description": "Media width in pixels; null when unknown.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "height": {
                                  "description": "Media height in pixels; null when unknown.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "type",
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Attached images and videos, in order; empty for text-only posts."
                          },
                          "link_preview": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "type": "string",
                                    "description": "The link's destination URL, without Threads' l.threads.com redirect."
                                  },
                                  "title": {
                                    "description": "Card title; null when omitted.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "image_url": {
                                    "description": "Card image URL; the link can expire. Null when the card has no image.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "domain": {
                                    "description": "Domain shown on the card, e.g. nytimes.com; null when omitted.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "url",
                                  "title",
                                  "image_url",
                                  "domain"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The link preview card; null when the post has none. Its URL often isn't in `text`."
                          },
                          "topic": {
                            "description": "Topic tag shown on the post, e.g. NFL Threads; null when untagged.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "is_reply": {
                            "description": "Whether this is a reply to another post; null when unknown.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "is_pinned": {
                            "description": "Whether Threads marks the post as pinned; null when unknown.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "quoted_post": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Numeric Threads post id, as a string."
                                  },
                                  "code": {
                                    "type": "string",
                                    "description": "The post's shortcode, as in its URL."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The post's URL on threads.com."
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "Post text; empty for posts that contain only media."
                                  },
                                  "created_at": {
                                    "description": "When it was posted, ISO 8601; null when unknown.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "like_count": {
                                    "description": "Likes; null when Threads doesn't show the count.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "reply_count": {
                                    "description": "Direct replies; null when unknown.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "repost_count": {
                                    "description": "Reposts; null when unknown.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "quote_count": {
                                    "description": "Quote posts; null when unknown.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "author": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "id": {
                                            "type": "string",
                                            "description": "Numeric Threads account id, as a string."
                                          },
                                          "username": {
                                            "type": "string",
                                            "description": "Account username without @."
                                          },
                                          "name": {
                                            "description": "Display name; null when the public post omits it.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "is_verified": {
                                            "description": "Whether the author has a verified badge; null when unknown.",
                                            "type": [
                                              "boolean",
                                              "null"
                                            ]
                                          },
                                          "profile_pic_url": {
                                            "description": "Profile picture URL; null when the public post omits it.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "id",
                                          "username",
                                          "name",
                                          "is_verified",
                                          "profile_pic_url"
                                        ],
                                        "additionalProperties": false,
                                        "description": "Who posted it; null when Threads doesn't say."
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ]
                                  },
                                  "media": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "type": {
                                          "type": "string",
                                          "enum": [
                                            "image",
                                            "video"
                                          ],
                                          "description": "Whether the URL is an image or a playable video file."
                                        },
                                        "url": {
                                          "type": "string",
                                          "description": "The largest image or video file Threads offers. The link can expire."
                                        },
                                        "width": {
                                          "description": "Media width in pixels; null when unknown.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        },
                                        "height": {
                                          "description": "Media height in pixels; null when unknown.",
                                          "type": [
                                            "number",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "type",
                                        "url",
                                        "width",
                                        "height"
                                      ],
                                      "additionalProperties": false
                                    },
                                    "description": "Attached images and videos, in order; empty for text-only posts."
                                  },
                                  "link_preview": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "url": {
                                            "type": "string",
                                            "description": "The link's destination URL, without Threads' l.threads.com redirect."
                                          },
                                          "title": {
                                            "description": "Card title; null when omitted.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "image_url": {
                                            "description": "Card image URL; the link can expire. Null when the card has no image.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "domain": {
                                            "description": "Domain shown on the card, e.g. nytimes.com; null when omitted.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "url",
                                          "title",
                                          "image_url",
                                          "domain"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The link preview card; null when the post has none. Its URL often isn't in `text`."
                                  },
                                  "topic": {
                                    "description": "Topic tag shown on the post, e.g. NFL Threads; null when untagged.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "is_reply": {
                                    "description": "Whether this is a reply to another post; null when unknown.",
                                    "type": [
                                      "boolean",
                                      "null"
                                    ]
                                  },
                                  "is_pinned": {
                                    "description": "Whether Threads marks the post as pinned; null when unknown.",
                                    "type": [
                                      "boolean",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "id",
                                  "code",
                                  "url",
                                  "text",
                                  "created_at",
                                  "like_count",
                                  "reply_count",
                                  "repost_count",
                                  "quote_count",
                                  "author",
                                  "media",
                                  "link_preview",
                                  "topic",
                                  "is_reply",
                                  "is_pinned"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The post this one quotes, with the same fields except its own quoted_post; null when it quotes nothing or the quoted post is unavailable."
                          }
                        },
                        "required": [
                          "id",
                          "code",
                          "url",
                          "text",
                          "created_at",
                          "like_count",
                          "reply_count",
                          "repost_count",
                          "quote_count",
                          "author",
                          "media",
                          "link_preview",
                          "topic",
                          "is_reply",
                          "is_pinned",
                          "quoted_post"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Posts in feed order, including the author's replies to their own posts. Each post appears once per page."
                    },
                    "next_cursor": {
                      "description": "Pass as `cursor` for the next page; null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "Whether there's another page. False when `next_cursor` is null."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "next_cursor",
                    "has_more"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/threads/post": {
      "get": {
        "operationId": "threads_post",
        "tags": [
          "Threads"
        ],
        "summary": "Threads post",
        "description": "The text, author, media and engagement of one public Threads post.\n\nUse it to read one post: its text, author, media, link preview, quoted post and engagement counts. Pass a public threads.com or threads.net post URL.\n\nYou get that post only, not its replies or the posts Threads suggests next to it. An unknown or deleted post returns 404 `not_found`. If Threads sends back an incomplete page, the call fails with `upstream_error`, which is free.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/threads/post"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A public post URL on threads.com or threads.net, in the form /@<username>/post/<code>, e.g. https://www.threads.com/@zuck/post/Dd1MqfcG0aH.",
            "schema": {
              "description": "A public post URL on threads.com or threads.net, in the form /@<username>/post/<code>, e.g. https://www.threads.com/@zuck/post/Dd1MqfcG0aH.",
              "type": "string"
            },
            "example": "https://www.threads.com/@zuck/post/Dd1MqfcG0aH"
          }
        ],
        "responses": {
          "200": {
            "description": "The text, author, media and engagement of one public Threads post.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Numeric Threads post id, as a string."
                    },
                    "code": {
                      "type": "string",
                      "description": "The post's shortcode, as in its URL."
                    },
                    "url": {
                      "type": "string",
                      "description": "The post's URL on threads.com."
                    },
                    "text": {
                      "type": "string",
                      "description": "Post text; empty for posts that contain only media."
                    },
                    "created_at": {
                      "description": "When it was posted, ISO 8601; null when unknown.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "like_count": {
                      "description": "Likes; null when Threads doesn't show the count.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "reply_count": {
                      "description": "Direct replies; null when unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "repost_count": {
                      "description": "Reposts; null when unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "quote_count": {
                      "description": "Quote posts; null when unknown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "author": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Numeric Threads account id, as a string."
                            },
                            "username": {
                              "type": "string",
                              "description": "Account username without @."
                            },
                            "name": {
                              "description": "Display name; null when the public post omits it.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "is_verified": {
                              "description": "Whether the author has a verified badge; null when unknown.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "profile_pic_url": {
                              "description": "Profile picture URL; null when the public post omits it.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "username",
                            "name",
                            "is_verified",
                            "profile_pic_url"
                          ],
                          "additionalProperties": false,
                          "description": "Who posted it; null when Threads doesn't say."
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "media": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "image",
                              "video"
                            ],
                            "description": "Whether the URL is an image or a playable video file."
                          },
                          "url": {
                            "type": "string",
                            "description": "The largest image or video file Threads offers. The link can expire."
                          },
                          "width": {
                            "description": "Media width in pixels; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "height": {
                            "description": "Media height in pixels; null when unknown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "url",
                          "width",
                          "height"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Attached images and videos, in order; empty for text-only posts."
                    },
                    "link_preview": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "url": {
                              "type": "string",
                              "description": "The link's destination URL, without Threads' l.threads.com redirect."
                            },
                            "title": {
                              "description": "Card title; null when omitted.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "image_url": {
                              "description": "Card image URL; the link can expire. Null when the card has no image.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "domain": {
                              "description": "Domain shown on the card, e.g. nytimes.com; null when omitted.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "url",
                            "title",
                            "image_url",
                            "domain"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The link preview card; null when the post has none. Its URL often isn't in `text`."
                    },
                    "topic": {
                      "description": "Topic tag shown on the post, e.g. NFL Threads; null when untagged.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "is_reply": {
                      "description": "Whether this is a reply to another post; null when unknown.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "is_pinned": {
                      "description": "Whether Threads marks the post as pinned; null when unknown.",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "quoted_post": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Numeric Threads post id, as a string."
                            },
                            "code": {
                              "type": "string",
                              "description": "The post's shortcode, as in its URL."
                            },
                            "url": {
                              "type": "string",
                              "description": "The post's URL on threads.com."
                            },
                            "text": {
                              "type": "string",
                              "description": "Post text; empty for posts that contain only media."
                            },
                            "created_at": {
                              "description": "When it was posted, ISO 8601; null when unknown.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "like_count": {
                              "description": "Likes; null when Threads doesn't show the count.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "reply_count": {
                              "description": "Direct replies; null when unknown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "repost_count": {
                              "description": "Reposts; null when unknown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "quote_count": {
                              "description": "Quote posts; null when unknown.",
                              "type": [
                                "number",
                                "null"
                              ]
                            },
                            "author": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "description": "Numeric Threads account id, as a string."
                                    },
                                    "username": {
                                      "type": "string",
                                      "description": "Account username without @."
                                    },
                                    "name": {
                                      "description": "Display name; null when the public post omits it.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "is_verified": {
                                      "description": "Whether the author has a verified badge; null when unknown.",
                                      "type": [
                                        "boolean",
                                        "null"
                                      ]
                                    },
                                    "profile_pic_url": {
                                      "description": "Profile picture URL; null when the public post omits it.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "username",
                                    "name",
                                    "is_verified",
                                    "profile_pic_url"
                                  ],
                                  "additionalProperties": false,
                                  "description": "Who posted it; null when Threads doesn't say."
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            },
                            "media": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "image",
                                      "video"
                                    ],
                                    "description": "Whether the URL is an image or a playable video file."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "The largest image or video file Threads offers. The link can expire."
                                  },
                                  "width": {
                                    "description": "Media width in pixels; null when unknown.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "height": {
                                    "description": "Media height in pixels; null when unknown.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "type",
                                  "url",
                                  "width",
                                  "height"
                                ],
                                "additionalProperties": false
                              },
                              "description": "Attached images and videos, in order; empty for text-only posts."
                            },
                            "link_preview": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "The link's destination URL, without Threads' l.threads.com redirect."
                                    },
                                    "title": {
                                      "description": "Card title; null when omitted.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "image_url": {
                                      "description": "Card image URL; the link can expire. Null when the card has no image.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "domain": {
                                      "description": "Domain shown on the card, e.g. nytimes.com; null when omitted.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "title",
                                    "image_url",
                                    "domain"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The link preview card; null when the post has none. Its URL often isn't in `text`."
                            },
                            "topic": {
                              "description": "Topic tag shown on the post, e.g. NFL Threads; null when untagged.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "is_reply": {
                              "description": "Whether this is a reply to another post; null when unknown.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "is_pinned": {
                              "description": "Whether Threads marks the post as pinned; null when unknown.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "code",
                            "url",
                            "text",
                            "created_at",
                            "like_count",
                            "reply_count",
                            "repost_count",
                            "quote_count",
                            "author",
                            "media",
                            "link_preview",
                            "topic",
                            "is_reply",
                            "is_pinned"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "The post this one quotes, with the same fields except its own quoted_post; null when it quotes nothing or the quoted post is unavailable."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "code",
                    "url",
                    "text",
                    "created_at",
                    "like_count",
                    "reply_count",
                    "repost_count",
                    "quote_count",
                    "author",
                    "media",
                    "link_preview",
                    "topic",
                    "is_reply",
                    "is_pinned",
                    "quoted_post"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instagram/profile": {
      "get": {
        "operationId": "instagram_profile",
        "tags": [
          "Instagram"
        ],
        "summary": "Profile",
        "description": "A public profile's biography, links and follower counts.\n\nUse it to look up a brand or creator: bio, links, follower and following counts, and whether the account is private or verified. Pass a username or profile URL. For their posts, use user posts (instagram_user_posts).\n\nInstagram doesn't always return the post count or a high-resolution picture. Missing fields are null.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "username",
            "in": "query",
            "required": false,
            "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
            "schema": {
              "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "nike"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
            "schema": {
              "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
              "type": "string",
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A public profile's biography, links and follower counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "pk": {
                          "type": "string",
                          "description": "Numeric Instagram user id, as a string."
                        },
                        "id": {
                          "description": "Instagram's longer account id (for a business or creator account, the id Meta's Graph API uses). pk is the shorter user id; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "username": {
                          "type": "string",
                          "description": "Instagram username, without @."
                        },
                        "url": {
                          "type": "string",
                          "description": "Canonical Instagram profile URL."
                        },
                        "full_name": {
                          "description": "Display name; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "biography": {
                          "description": "Biography, preserving line breaks; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "profile_pic_url": {
                          "description": "Profile image URL; CDN links can expire; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "profile_pic_url_hd": {
                          "description": "Higher resolution profile image URL, when available; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "is_private": {
                          "description": "Whether the account is private; null when not returned.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "is_verified": {
                          "description": "Whether Instagram shows a verified badge; null when not returned.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "follower_count": {
                          "description": "Follower count; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "following_count": {
                          "description": "Number of accounts followed; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "media_count": {
                          "description": "Number of posts. Instagram hides it from logged-out visitors, so it's usually null; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "external_url": {
                          "description": "Main website link in the profile; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "bio_links": {
                          "anyOf": [
                            {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "type": "string",
                                    "description": "The link's destination URL."
                                  },
                                  "title": {
                                    "description": "Link title; an empty title means none was set; null when not returned.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "url",
                                  "title"
                                ],
                                "additionalProperties": false
                              }
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Links listed in the bio, in Instagram's order; null when not returned."
                        },
                        "pronouns": {
                          "anyOf": [
                            {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Pronouns the user set; null when not returned, empty when none are set."
                        },
                        "account_type": {
                          "description": "Instagram's account type code, e.g. 2; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "category": {
                          "description": "Category label; an empty string means Instagram returned no label; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "total_clips_count": {
                          "description": "Reel count. Always null, since Instagram shows logged-out visitors the same placeholder (1) for every account.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "pk",
                        "id",
                        "username",
                        "url",
                        "full_name",
                        "biography",
                        "profile_pic_url",
                        "profile_pic_url_hd",
                        "is_private",
                        "is_verified",
                        "follower_count",
                        "following_count",
                        "media_count",
                        "external_url",
                        "bio_links",
                        "pronouns",
                        "account_type",
                        "category",
                        "total_clips_count"
                      ],
                      "additionalProperties": false,
                      "description": "Profile details."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "data"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v2/instagram/user/posts": {
      "get": {
        "operationId": "instagram_user_posts",
        "tags": [
          "Instagram"
        ],
        "summary": "User posts",
        "description": "A page of public posts with captions, media and engagement counts.\n\nUse it to follow what an account posts: captions, media, and like and comment counts. Pass a username or profile URL, and `first` for how many posts you want. Instagram sends at most 12 a page, so a larger `first` still returns 12.\n\nPosts come in Instagram's timeline order, which can include pinned posts. A private account's posts aren't available. Cached pages cost the same as fresh ones.\n\n**Pagination.** Pass `end_cursor` back as `after`, unchanged, for the next page. `has_next_page` is false on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/user-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "username",
            "in": "query",
            "required": false,
            "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
            "schema": {
              "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "nike"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
            "schema": {
              "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "first",
            "in": "query",
            "required": false,
            "description": "How many items to ask for, 1–50 (default 12). Instagram may return fewer.",
            "schema": {
              "default": 12,
              "description": "How many items to ask for, 1–50 (default 12). Instagram may return fewer.",
              "type": "integer",
              "minimum": 1,
              "maximum": 50
            },
            "example": 12
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "The `end_cursor` from the previous page, unchanged. Leave it out for the first page.",
            "schema": {
              "description": "The `end_cursor` from the previous page, unchanged. Leave it out for the first page.",
              "type": "string",
              "minLength": 1,
              "maxLength": 8192
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of public posts with captions, media and engagement counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "pk": {
                            "type": "string",
                            "description": "Numeric media id, as a string."
                          },
                          "media_type": {
                            "type": "number",
                            "description": "Instagram media type: 1 photo, 2 video, 8 carousel."
                          },
                          "display_url": {
                            "description": "Preview image URL; CDN links can expire; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Direct image URL; CDN links can expire."
                                },
                                "width": {
                                  "description": "Image width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "height": {
                                  "description": "Image height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false,
                              "description": "One available image size."
                            },
                            "description": "Available image sizes; empty when none are returned."
                          },
                          "videos": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Direct MP4 URL; CDN links can expire."
                                },
                                "width": {
                                  "description": "Video width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                },
                                "height": {
                                  "description": "Video height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "url",
                                "width",
                                "height"
                              ],
                              "additionalProperties": false,
                              "description": "One available video size."
                            },
                            "description": "Available MP4 versions; empty for photos or when video URLs are unavailable."
                          },
                          "usertags": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "user": {
                                      "type": "object",
                                      "properties": {
                                        "pk": {
                                          "type": "string",
                                          "description": "The account's numeric Instagram id, as a string."
                                        },
                                        "username": {
                                          "type": "string",
                                          "description": "Instagram username, without @."
                                        },
                                        "full_name": {
                                          "description": "Display name; null when not returned.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "profile_pic_url": {
                                          "description": "Profile image URL; CDN links can expire; null when not returned.",
                                          "type": [
                                            "string",
                                            "null"
                                          ]
                                        },
                                        "is_verified": {
                                          "description": "Whether Instagram shows a verified badge; null when not returned.",
                                          "type": [
                                            "boolean",
                                            "null"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "pk",
                                        "username",
                                        "full_name",
                                        "profile_pic_url",
                                        "is_verified"
                                      ],
                                      "additionalProperties": false,
                                      "description": "The tagged account."
                                    },
                                    "position": {
                                      "anyOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "x": {
                                              "type": "number",
                                              "description": "Distance from the left edge, as a fraction of the width (0 to 1)."
                                            },
                                            "y": {
                                              "type": "number",
                                              "description": "Distance from the top edge, as a fraction of the height (0 to 1)."
                                            }
                                          },
                                          "required": [
                                            "x",
                                            "y"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "null"
                                        }
                                      ],
                                      "description": "Where the tag sits on the image; null when Instagram gives none (video tags come as 0, 0)."
                                    }
                                  },
                                  "required": [
                                    "user",
                                    "position"
                                  ],
                                  "additionalProperties": false,
                                  "description": "One tagged account."
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Accounts tagged in this media, in Instagram's order; null when Instagram returns no tag list. On a carousel it lists every slide's tags; each carousel item has its own."
                          },
                          "code": {
                            "type": "string",
                            "description": "The post's case-sensitive shortcode."
                          },
                          "url": {
                            "type": "string",
                            "description": "Canonical Instagram post URL."
                          },
                          "product_type": {
                            "description": "Instagram product type, e.g. clips for a reel or feed for a feed post; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "caption": {
                            "description": "Post caption as plain text, preserving line breaks; null when the post has no caption.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "taken_at": {
                            "description": "When it was posted, as Unix seconds; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "like_count": {
                            "description": "Like count; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "comment_count": {
                            "description": "Comment count; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "play_count": {
                            "description": "Play count. Instagram usually leaves it out for logged-out visitors; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "view_count": {
                            "description": "View count. Instagram usually leaves it out for logged-out visitors; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "accessibility_caption": {
                            "description": "Instagram's accessibility description; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "user": {
                            "type": "object",
                            "properties": {
                              "pk": {
                                "type": "string",
                                "description": "The account's numeric Instagram id, as a string."
                              },
                              "username": {
                                "type": "string",
                                "description": "Instagram username, without @."
                              },
                              "full_name": {
                                "description": "Display name; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "profile_pic_url": {
                                "description": "Profile image URL; CDN links can expire; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "is_verified": {
                                "description": "Whether Instagram shows a verified badge; null when not returned.",
                                "type": [
                                  "boolean",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "pk",
                              "username",
                              "full_name",
                              "profile_pic_url",
                              "is_verified"
                            ],
                            "additionalProperties": false,
                            "description": "Post author."
                          },
                          "coauthor_producers": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "pk": {
                                  "type": "string",
                                  "description": "The account's numeric Instagram id, as a string."
                                },
                                "username": {
                                  "type": "string",
                                  "description": "Instagram username, without @."
                                },
                                "full_name": {
                                  "description": "Display name; null when not returned.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "profile_pic_url": {
                                  "description": "Profile image URL; CDN links can expire; null when not returned.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "is_verified": {
                                  "description": "Whether Instagram shows a verified badge; null when not returned.",
                                  "type": [
                                    "boolean",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "pk",
                                "username",
                                "full_name",
                                "profile_pic_url",
                                "is_verified"
                              ],
                              "additionalProperties": false,
                              "description": "The account that published this item."
                            },
                            "description": "The post's co-authors; empty when there are none."
                          },
                          "is_paid_partnership": {
                            "description": "Whether Instagram marks the post as a paid partnership; null when not returned.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "location": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "pk": {
                                    "description": "Numeric location id; null when not returned.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "name": {
                                    "description": "Location name; null when not returned.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "pk",
                                  "name"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Tagged location; null when none is returned."
                          },
                          "carousel_media": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "pk": {
                                  "type": "string",
                                  "description": "Numeric media id, as a string."
                                },
                                "media_type": {
                                  "type": "number",
                                  "description": "Instagram media type: 1 photo, 2 video, 8 carousel."
                                },
                                "display_url": {
                                  "description": "Preview image URL; CDN links can expire; null when not returned.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "images": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "url": {
                                        "type": "string",
                                        "description": "Direct image URL; CDN links can expire."
                                      },
                                      "width": {
                                        "description": "Image width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "height": {
                                        "description": "Image height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "url",
                                      "width",
                                      "height"
                                    ],
                                    "additionalProperties": false,
                                    "description": "One available image size."
                                  },
                                  "description": "Available image sizes; empty when none are returned."
                                },
                                "videos": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "url": {
                                        "type": "string",
                                        "description": "Direct MP4 URL; CDN links can expire."
                                      },
                                      "width": {
                                        "description": "Video width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      },
                                      "height": {
                                        "description": "Video height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                        "type": [
                                          "number",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "url",
                                      "width",
                                      "height"
                                    ],
                                    "additionalProperties": false,
                                    "description": "One available video size."
                                  },
                                  "description": "Available MP4 versions; empty for photos or when video URLs are unavailable."
                                },
                                "usertags": {
                                  "anyOf": [
                                    {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "user": {
                                            "type": "object",
                                            "properties": {
                                              "pk": {
                                                "type": "string",
                                                "description": "The account's numeric Instagram id, as a string."
                                              },
                                              "username": {
                                                "type": "string",
                                                "description": "Instagram username, without @."
                                              },
                                              "full_name": {
                                                "description": "Display name; null when not returned.",
                                                "type": [
                                                  "string",
                                                  "null"
                                                ]
                                              },
                                              "profile_pic_url": {
                                                "description": "Profile image URL; CDN links can expire; null when not returned.",
                                                "type": [
                                                  "string",
                                                  "null"
                                                ]
                                              },
                                              "is_verified": {
                                                "description": "Whether Instagram shows a verified badge; null when not returned.",
                                                "type": [
                                                  "boolean",
                                                  "null"
                                                ]
                                              }
                                            },
                                            "required": [
                                              "pk",
                                              "username",
                                              "full_name",
                                              "profile_pic_url",
                                              "is_verified"
                                            ],
                                            "additionalProperties": false,
                                            "description": "The tagged account."
                                          },
                                          "position": {
                                            "anyOf": [
                                              {
                                                "type": "object",
                                                "properties": {
                                                  "x": {
                                                    "type": "number",
                                                    "description": "Distance from the left edge, as a fraction of the width (0 to 1)."
                                                  },
                                                  "y": {
                                                    "type": "number",
                                                    "description": "Distance from the top edge, as a fraction of the height (0 to 1)."
                                                  }
                                                },
                                                "required": [
                                                  "x",
                                                  "y"
                                                ],
                                                "additionalProperties": false
                                              },
                                              {
                                                "type": "null"
                                              }
                                            ],
                                            "description": "Where the tag sits on the image; null when Instagram gives none (video tags come as 0, 0)."
                                          }
                                        },
                                        "required": [
                                          "user",
                                          "position"
                                        ],
                                        "additionalProperties": false,
                                        "description": "One tagged account."
                                      }
                                    },
                                    {
                                      "type": "null"
                                    }
                                  ],
                                  "description": "Accounts tagged in this media, in Instagram's order; null when Instagram returns no tag list. On a carousel it lists every slide's tags; each carousel item has its own."
                                }
                              },
                              "required": [
                                "pk",
                                "media_type",
                                "display_url",
                                "images",
                                "videos",
                                "usertags"
                              ],
                              "additionalProperties": false,
                              "description": "One carousel item."
                            },
                            "description": "Carousel items in order; empty for single-media posts."
                          }
                        },
                        "required": [
                          "pk",
                          "media_type",
                          "display_url",
                          "images",
                          "videos",
                          "usertags",
                          "code",
                          "url",
                          "product_type",
                          "caption",
                          "taken_at",
                          "like_count",
                          "comment_count",
                          "play_count",
                          "view_count",
                          "accessibility_caption",
                          "user",
                          "coauthor_producers",
                          "is_paid_partnership",
                          "location",
                          "carousel_media"
                        ],
                        "additionalProperties": false,
                        "description": "A public post or reel, with its media and engagement. Missing counts stay null."
                      },
                      "description": "Posts in Instagram's timeline order, which can include pinned posts."
                    },
                    "end_cursor": {
                      "description": "Pass it as `after` for the next page; null when not returned.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "has_next_page": {
                      "type": "boolean",
                      "description": "Whether there's another page. False on the last page."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "posts",
                    "end_cursor",
                    "has_next_page"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instagram/post": {
      "get": {
        "operationId": "instagram_post",
        "tags": [
          "Instagram"
        ],
        "summary": "Post",
        "description": "A public photo, carousel, video or reel with its caption and counts.\n\nUse it to read one post or reel: caption, author, media, tagged accounts, location and the counts a logged-out visitor sees. Pass a post URL or shortcode. For its comments, use post comments (instagram_post_comments).\n\nA missing post returns 404 `not_found` and a private one 403 `not_public`. Media links expire, so save what you need.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/post"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "required": false,
            "description": "The post's shortcode, the part after /p/ or /reel/ in its URL, e.g. `Ddl5eH-u4le`. Required unless you pass `url`.",
            "schema": {
              "description": "The post's shortcode, the part after /p/ or /reel/ in its URL, e.g. `Ddl5eH-u4le`. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A post or reel URL (instagram.com/p/…, /reel/…, /reels/… or /tv/…), or just its shortcode. Required unless you pass `code`.",
            "schema": {
              "description": "A post or reel URL (instagram.com/p/…, /reel/…, /reels/… or /tv/…), or just its shortcode. Required unless you pass `code`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.instagram.com/reel/Ddl5eH-u4le/"
          }
        ],
        "responses": {
          "200": {
            "description": "A public photo, carousel, video or reel with its caption and counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "pk": {
                          "type": "string",
                          "description": "Numeric media id, as a string."
                        },
                        "media_type": {
                          "type": "number",
                          "description": "Instagram media type: 1 photo, 2 video, 8 carousel."
                        },
                        "display_url": {
                          "description": "Preview image URL; CDN links can expire; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "images": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "url": {
                                "type": "string",
                                "description": "Direct image URL; CDN links can expire."
                              },
                              "width": {
                                "description": "Image width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "height": {
                                "description": "Image height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "url",
                              "width",
                              "height"
                            ],
                            "additionalProperties": false,
                            "description": "One available image size."
                          },
                          "description": "Available image sizes; empty when none are returned."
                        },
                        "videos": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "url": {
                                "type": "string",
                                "description": "Direct MP4 URL; CDN links can expire."
                              },
                              "width": {
                                "description": "Video width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              },
                              "height": {
                                "description": "Video height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                "type": [
                                  "number",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "url",
                              "width",
                              "height"
                            ],
                            "additionalProperties": false,
                            "description": "One available video size."
                          },
                          "description": "Available MP4 versions; empty for photos or when video URLs are unavailable."
                        },
                        "usertags": {
                          "anyOf": [
                            {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "user": {
                                    "type": "object",
                                    "properties": {
                                      "pk": {
                                        "type": "string",
                                        "description": "The account's numeric Instagram id, as a string."
                                      },
                                      "username": {
                                        "type": "string",
                                        "description": "Instagram username, without @."
                                      },
                                      "full_name": {
                                        "description": "Display name; null when not returned.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "profile_pic_url": {
                                        "description": "Profile image URL; CDN links can expire; null when not returned.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "is_verified": {
                                        "description": "Whether Instagram shows a verified badge; null when not returned.",
                                        "type": [
                                          "boolean",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "pk",
                                      "username",
                                      "full_name",
                                      "profile_pic_url",
                                      "is_verified"
                                    ],
                                    "additionalProperties": false,
                                    "description": "The tagged account."
                                  },
                                  "position": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "x": {
                                            "type": "number",
                                            "description": "Distance from the left edge, as a fraction of the width (0 to 1)."
                                          },
                                          "y": {
                                            "type": "number",
                                            "description": "Distance from the top edge, as a fraction of the height (0 to 1)."
                                          }
                                        },
                                        "required": [
                                          "x",
                                          "y"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "Where the tag sits on the image; null when Instagram gives none (video tags come as 0, 0)."
                                  }
                                },
                                "required": [
                                  "user",
                                  "position"
                                ],
                                "additionalProperties": false,
                                "description": "One tagged account."
                              }
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Accounts tagged in this media, in Instagram's order; null when Instagram returns no tag list. On a carousel it lists every slide's tags; each carousel item has its own."
                        },
                        "code": {
                          "type": "string",
                          "description": "The post's case-sensitive shortcode."
                        },
                        "url": {
                          "type": "string",
                          "description": "Canonical Instagram post URL."
                        },
                        "product_type": {
                          "description": "Instagram product type, e.g. clips for a reel or feed for a feed post; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "caption": {
                          "description": "Post caption as plain text, preserving line breaks; null when the post has no caption.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "taken_at": {
                          "description": "When it was posted, as Unix seconds; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "like_count": {
                          "description": "Like count; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "comment_count": {
                          "description": "Comment count; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "play_count": {
                          "description": "Play count. Instagram usually leaves it out for logged-out visitors; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "view_count": {
                          "description": "View count. Instagram usually leaves it out for logged-out visitors; null when Instagram doesn't show it. Null doesn't mean zero.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "accessibility_caption": {
                          "description": "Instagram's accessibility description; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "user": {
                          "type": "object",
                          "properties": {
                            "pk": {
                              "type": "string",
                              "description": "The account's numeric Instagram id, as a string."
                            },
                            "username": {
                              "type": "string",
                              "description": "Instagram username, without @."
                            },
                            "full_name": {
                              "description": "Display name; null when not returned.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "profile_pic_url": {
                              "description": "Profile image URL; CDN links can expire; null when not returned.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "is_verified": {
                              "description": "Whether Instagram shows a verified badge; null when not returned.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "pk",
                            "username",
                            "full_name",
                            "profile_pic_url",
                            "is_verified"
                          ],
                          "additionalProperties": false,
                          "description": "Post author."
                        },
                        "coauthor_producers": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "pk": {
                                "type": "string",
                                "description": "The account's numeric Instagram id, as a string."
                              },
                              "username": {
                                "type": "string",
                                "description": "Instagram username, without @."
                              },
                              "full_name": {
                                "description": "Display name; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "profile_pic_url": {
                                "description": "Profile image URL; CDN links can expire; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "is_verified": {
                                "description": "Whether Instagram shows a verified badge; null when not returned.",
                                "type": [
                                  "boolean",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "pk",
                              "username",
                              "full_name",
                              "profile_pic_url",
                              "is_verified"
                            ],
                            "additionalProperties": false,
                            "description": "The account that published this item."
                          },
                          "description": "The post's co-authors; empty when there are none."
                        },
                        "is_paid_partnership": {
                          "description": "Whether Instagram marks the post as a paid partnership; null when not returned.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "location": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "pk": {
                                  "description": "Numeric location id; null when not returned.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "name": {
                                  "description": "Location name; null when not returned.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "pk",
                                "name"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Tagged location; null when none is returned."
                        },
                        "carousel_media": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "pk": {
                                "type": "string",
                                "description": "Numeric media id, as a string."
                              },
                              "media_type": {
                                "type": "number",
                                "description": "Instagram media type: 1 photo, 2 video, 8 carousel."
                              },
                              "display_url": {
                                "description": "Preview image URL; CDN links can expire; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "images": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "Direct image URL; CDN links can expire."
                                    },
                                    "width": {
                                      "description": "Image width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "height": {
                                      "description": "Image height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "width",
                                    "height"
                                  ],
                                  "additionalProperties": false,
                                  "description": "One available image size."
                                },
                                "description": "Available image sizes; empty when none are returned."
                              },
                              "videos": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "url": {
                                      "type": "string",
                                      "description": "Direct MP4 URL; CDN links can expire."
                                    },
                                    "width": {
                                      "description": "Video width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    },
                                    "height": {
                                      "description": "Video height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                                      "type": [
                                        "number",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "url",
                                    "width",
                                    "height"
                                  ],
                                  "additionalProperties": false,
                                  "description": "One available video size."
                                },
                                "description": "Available MP4 versions; empty for photos or when video URLs are unavailable."
                              },
                              "usertags": {
                                "anyOf": [
                                  {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "user": {
                                          "type": "object",
                                          "properties": {
                                            "pk": {
                                              "type": "string",
                                              "description": "The account's numeric Instagram id, as a string."
                                            },
                                            "username": {
                                              "type": "string",
                                              "description": "Instagram username, without @."
                                            },
                                            "full_name": {
                                              "description": "Display name; null when not returned.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "profile_pic_url": {
                                              "description": "Profile image URL; CDN links can expire; null when not returned.",
                                              "type": [
                                                "string",
                                                "null"
                                              ]
                                            },
                                            "is_verified": {
                                              "description": "Whether Instagram shows a verified badge; null when not returned.",
                                              "type": [
                                                "boolean",
                                                "null"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "pk",
                                            "username",
                                            "full_name",
                                            "profile_pic_url",
                                            "is_verified"
                                          ],
                                          "additionalProperties": false,
                                          "description": "The tagged account."
                                        },
                                        "position": {
                                          "anyOf": [
                                            {
                                              "type": "object",
                                              "properties": {
                                                "x": {
                                                  "type": "number",
                                                  "description": "Distance from the left edge, as a fraction of the width (0 to 1)."
                                                },
                                                "y": {
                                                  "type": "number",
                                                  "description": "Distance from the top edge, as a fraction of the height (0 to 1)."
                                                }
                                              },
                                              "required": [
                                                "x",
                                                "y"
                                              ],
                                              "additionalProperties": false
                                            },
                                            {
                                              "type": "null"
                                            }
                                          ],
                                          "description": "Where the tag sits on the image; null when Instagram gives none (video tags come as 0, 0)."
                                        }
                                      },
                                      "required": [
                                        "user",
                                        "position"
                                      ],
                                      "additionalProperties": false,
                                      "description": "One tagged account."
                                    }
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "Accounts tagged in this media, in Instagram's order; null when Instagram returns no tag list. On a carousel it lists every slide's tags; each carousel item has its own."
                              }
                            },
                            "required": [
                              "pk",
                              "media_type",
                              "display_url",
                              "images",
                              "videos",
                              "usertags"
                            ],
                            "additionalProperties": false,
                            "description": "One carousel item."
                          },
                          "description": "Carousel items in order; empty for single-media posts."
                        }
                      },
                      "required": [
                        "pk",
                        "media_type",
                        "display_url",
                        "images",
                        "videos",
                        "usertags",
                        "code",
                        "url",
                        "product_type",
                        "caption",
                        "taken_at",
                        "like_count",
                        "comment_count",
                        "play_count",
                        "view_count",
                        "accessibility_caption",
                        "user",
                        "coauthor_producers",
                        "is_paid_partnership",
                        "location",
                        "carousel_media"
                      ],
                      "additionalProperties": false,
                      "description": "The requested post."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "data"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v2/instagram/post/comments": {
      "get": {
        "operationId": "instagram_post_comments",
        "tags": [
          "Instagram"
        ],
        "summary": "Post comments",
        "description": "A page of public comments with authors, timestamps and likes.\n\nUse it to read what people say under a post: each comment's text, author, time and likes. Pass a post URL or shortcode.\n\nComments come in Instagram's own order, which isn't always by time. Reply threads aren't loaded, and the reply count is often missing (null).\n\n**Pagination.** Pass `end_cursor` back as `after` for the next page. `has_next_page` is false on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/post-comments"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "required": false,
            "description": "The post's shortcode, the part after /p/ or /reel/ in its URL, e.g. `Ddl5eH-u4le`. Required unless you pass `url`.",
            "schema": {
              "description": "The post's shortcode, the part after /p/ or /reel/ in its URL, e.g. `Ddl5eH-u4le`. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A post or reel URL (instagram.com/p/…, /reel/…, /reels/… or /tv/…), or just its shortcode. Required unless you pass `code`.",
            "schema": {
              "description": "A post or reel URL (instagram.com/p/…, /reel/…, /reels/… or /tv/…), or just its shortcode. Required unless you pass `code`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.instagram.com/p/aye83DjauH/"
          },
          {
            "name": "first",
            "in": "query",
            "required": false,
            "description": "How many items to ask for, 1–50 (default 12). Instagram may return fewer.",
            "schema": {
              "default": 12,
              "description": "How many items to ask for, 1–50 (default 12). Instagram may return fewer.",
              "type": "integer",
              "minimum": 1,
              "maximum": 50
            },
            "example": 15
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "The `end_cursor` from the previous page, unchanged. Leave it out for the first page.",
            "schema": {
              "description": "The `end_cursor` from the previous page, unchanged. Leave it out for the first page.",
              "type": "string",
              "minLength": 1,
              "maxLength": 8192
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of public comments with authors, timestamps and likes.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "comments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "pk": {
                            "type": "string",
                            "description": "Comment id, as a string."
                          },
                          "text": {
                            "type": "string",
                            "description": "Comment text, preserving line breaks."
                          },
                          "created_at": {
                            "description": "When it was posted, as Unix seconds; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "comment_like_count": {
                            "description": "Number of likes on the comment; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "child_comment_count": {
                            "description": "Reply count; frequently omitted in the public view; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "parent_comment_id": {
                            "description": "Parent comment id; null for top-level comments or when unavailable; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "user": {
                            "type": "object",
                            "properties": {
                              "pk": {
                                "type": "string",
                                "description": "The account's numeric Instagram id, as a string."
                              },
                              "username": {
                                "type": "string",
                                "description": "Instagram username, without @."
                              },
                              "full_name": {
                                "description": "Display name; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "profile_pic_url": {
                                "description": "Profile image URL; CDN links can expire; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "is_verified": {
                                "description": "Whether Instagram shows a verified badge; null when not returned.",
                                "type": [
                                  "boolean",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "pk",
                              "username",
                              "full_name",
                              "profile_pic_url",
                              "is_verified"
                            ],
                            "additionalProperties": false,
                            "description": "Comment author."
                          }
                        },
                        "required": [
                          "pk",
                          "text",
                          "created_at",
                          "comment_like_count",
                          "child_comment_count",
                          "parent_comment_id",
                          "user"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The comments Instagram returned for this page."
                    },
                    "end_cursor": {
                      "description": "Pass it as `after` for the next page; null when not returned.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "has_next_page": {
                      "type": "boolean",
                      "description": "Whether there's another page. False on the last page."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "comments",
                    "end_cursor",
                    "has_next_page"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instagram/user/reels": {
      "get": {
        "operationId": "instagram_user_reels",
        "tags": [
          "Instagram"
        ],
        "summary": "User reels",
        "description": "A page of public reel previews with play, like and comment counts.\n\nUse it to see which of an account's reels get the most plays. Pass a username or profile URL. You get each reel's cover image and its play, like and comment counts, as the reels tab shows them, plus the account's follower count, so engagement rate takes one call.\n\nCaptions, dates and video URLs aren't included. For those, pass a reel's `code` to the post endpoint (instagram_post). A private account's reels aren't available.\n\n**Pagination.** Pass `end_cursor` back as `after` for the next page. `has_next_page` is false on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/user-reels"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "username",
            "in": "query",
            "required": false,
            "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
            "schema": {
              "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "nike"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
            "schema": {
              "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "first",
            "in": "query",
            "required": false,
            "description": "How many items to ask for, 1–50 (default 12). Instagram may return fewer.",
            "schema": {
              "default": 12,
              "description": "How many items to ask for, 1–50 (default 12). Instagram may return fewer.",
              "type": "integer",
              "minimum": 1,
              "maximum": 50
            },
            "example": 12
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "The `end_cursor` from the previous page, unchanged. Leave it out for the first page.",
            "schema": {
              "description": "The `end_cursor` from the previous page, unchanged. Leave it out for the first page.",
              "type": "string",
              "minLength": 1,
              "maxLength": 8192
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of public reel previews with play, like and comment counts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "reels": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "pk": {
                            "type": "string",
                            "description": "Numeric reel media id, as a string."
                          },
                          "code": {
                            "type": "string",
                            "description": "The reel's shortcode (case-sensitive). Pass it as `code` to the post endpoint."
                          },
                          "url": {
                            "type": "string",
                            "description": "Canonical Instagram reel URL."
                          },
                          "display_url": {
                            "description": "Reel preview image URL; CDN links can expire; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "like_count": {
                            "description": "Like count; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "comment_count": {
                            "description": "Comment count; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "play_count": {
                            "description": "Play count; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "clips_tab_pinned_user_ids": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "User ids that pinned this reel in their reels tab; null when not returned."
                          }
                        },
                        "required": [
                          "pk",
                          "code",
                          "url",
                          "display_url",
                          "like_count",
                          "comment_count",
                          "play_count",
                          "clips_tab_pinned_user_ids"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Reel previews in Instagram's reels-tab order."
                    },
                    "end_cursor": {
                      "description": "Pass it as `after` for the next page; null when not returned.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "has_next_page": {
                      "type": "boolean",
                      "description": "Whether there's another page. False on the last page."
                    },
                    "follower_count": {
                      "description": "The account's follower count, as on its profile; null when Instagram doesn't show it. Null doesn't mean zero.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "reels",
                    "end_cursor",
                    "has_next_page",
                    "follower_count"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v2/instagram/media/transcript": {
      "get": {
        "operationId": "instagram_media_transcript",
        "tags": [
          "Instagram"
        ],
        "summary": "Media transcript",
        "description": "The words spoken in a public Instagram reel or video, as text.\n\nUse it to get what's said in a reel as text. Pass a public reel or video URL; it works on videos up to 120 seconds. For a carousel, its first video is transcribed. The post's author, caption and preview image come with the transcript.\n\nA new transcript costs 2 credits when speech-to-text succeeds. One we already have costs 1, since speech-to-text doesn't run again. A video with no audio or no speech returns 404 `transcript_unavailable` at the base price. (Instagram mutes reels whose song was removed.)\n\nPhotos, private posts, videos over 120 seconds and videos whose length Instagram doesn't give can't be transcribed. The transcript is machine-made and can contain mistakes.\n\nCost: 1 credit; 2 if speech-to-text runs.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/media-transcript"
        },
        "x-credits": 1,
        "x-extra-credits": {
          "asr": 1
        },
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "required": false,
            "description": "The post's shortcode, the part after /p/ or /reel/ in its URL, e.g. `Ddl5eH-u4le`. Required unless you pass `url`.",
            "schema": {
              "description": "The post's shortcode, the part after /p/ or /reel/ in its URL, e.g. `Ddl5eH-u4le`. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A post or reel URL (instagram.com/p/…, /reel/…, /reels/… or /tv/…), or just its shortcode. Required unless you pass `code`.",
            "schema": {
              "description": "A post or reel URL (instagram.com/p/…, /reel/…, /reels/… or /tv/…), or just its shortcode. Required unless you pass `code`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.instagram.com/reel/Ddl5eH-u4le/"
          },
          {
            "name": "max_credits",
            "in": "query",
            "required": false,
            "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
            "schema": {
              "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The words spoken in a public Instagram reel or video, as text.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "code": {
                      "type": "string",
                      "description": "The video's Instagram shortcode."
                    },
                    "url": {
                      "type": "string",
                      "description": "Canonical Instagram post URL."
                    },
                    "transcript": {
                      "type": "string",
                      "description": "Recognized speech as plain text; machine transcription may contain mistakes."
                    },
                    "language": {
                      "description": "The spoken language we detected, as an ISO 639-1 code (e.g. en); null when not returned.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "duration_s": {
                      "description": "Audio duration in seconds; null when Instagram doesn't show it. Null doesn't mean zero.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "segments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "start": {
                            "type": "number",
                            "description": "When the segment starts, in seconds from the beginning."
                          },
                          "end": {
                            "type": "number",
                            "description": "When the segment ends, in seconds from the beginning."
                          },
                          "text": {
                            "type": "string",
                            "description": "The words spoken in this segment."
                          }
                        },
                        "required": [
                          "start",
                          "end",
                          "text"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The transcript in timed segments; empty when unavailable."
                    },
                    "source": {
                      "type": "string",
                      "const": "speech_to_text",
                      "description": "How the transcript was produced: speech_to_text."
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "pk": {
                          "type": "string",
                          "description": "The account's numeric Instagram id, as a string."
                        },
                        "username": {
                          "type": "string",
                          "description": "Instagram username, without @."
                        },
                        "full_name": {
                          "description": "Display name; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "profile_pic_url": {
                          "description": "Profile image URL; CDN links can expire; null when not returned.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "is_verified": {
                          "description": "Whether Instagram shows a verified badge; null when not returned.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "pk",
                        "username",
                        "full_name",
                        "profile_pic_url",
                        "is_verified"
                      ],
                      "additionalProperties": false,
                      "description": "Post author."
                    },
                    "caption": {
                      "description": "Post caption as plain text, preserving line breaks; null when the post has no caption.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "taken_at": {
                      "description": "When it was posted, as Unix seconds; null when Instagram doesn't show it. Null doesn't mean zero.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "display_url": {
                      "description": "Preview image URL. Image links expire within days while transcripts are kept for 30, so it can be dead; null when not returned.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "code",
                    "url",
                    "transcript",
                    "language",
                    "duration_s",
                    "segments",
                    "source",
                    "user",
                    "caption",
                    "taken_at",
                    "display_url"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "400": {
            "description": "invalid_params: A parameter is missing or invalid. `issues` names each one.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "transcript_unavailable: The video has no captions, and speech-to-text heard no speech in it. You pay the base credit, never the speech-to-text extra. The answer is cached.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v2/instagram/reels/search": {
      "get": {
        "operationId": "instagram_reels_search",
        "tags": [
          "Instagram"
        ],
        "summary": "Search reels",
        "description": "Public reels Instagram ranks for a keyword, with plays, likes, comments and captions.\n\nUse it to find popular reels on a topic. Pass a keyword or phrase, or a hashtag's word (with or without #). Results come in Instagram's ranking, not by date.\n\nThese are the reels on Instagram's public keyword page (instagram.com/popular/<keyword>/), where Instagram also sends logged-out visitors who open a hashtag. You get about 12 reels per page and around 40 to 50 in all. A keyword Instagram has no page for (some brands and topics, such as `nike`) returns an empty list, and a count the author hides is null.\n\n**Pagination.** Pass the response's `cursor` back as `cursor` with the same query. `has_more` is false on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/reels-search"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "A keyword or phrase, e.g. `football` or `funny dogs`. A leading # is ignored, so a hashtag's word works too.",
            "schema": {
              "type": "string",
              "maxLength": 2048,
              "description": "A keyword or phrase, e.g. `football` or `funny dogs`. A leading # is ignored, so a hashtag's word works too."
            },
            "example": "funny dogs"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous page, unchanged. Leave it out for the first page.",
            "schema": {
              "description": "The `cursor` from the previous page, unchanged. Leave it out for the first page.",
              "type": "string",
              "minLength": 1,
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Public reels Instagram ranks for a keyword, with plays, likes, comments and captions.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "query": {
                      "type": "string",
                      "description": "The keyword searched, lowercased and without a leading #."
                    },
                    "reels": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "pk": {
                            "type": "string",
                            "description": "Numeric reel media id, as a string."
                          },
                          "code": {
                            "type": "string",
                            "description": "The reel's shortcode (case-sensitive). Pass it as `code` to the post endpoint."
                          },
                          "url": {
                            "type": "string",
                            "description": "Canonical Instagram reel URL."
                          },
                          "caption": {
                            "description": "Post caption as plain text, preserving line breaks; null when the post has no caption.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "taken_at": {
                            "description": "When it was posted, as Unix seconds; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "like_count": {
                            "description": "Like count; null when the author hides it; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "comment_count": {
                            "description": "Comment count; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "play_count": {
                            "description": "Play count, from Instagram's keyword grid; null when the grid didn't list this reel on the same page; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "display_url": {
                            "description": "Cover image URL; CDN links can expire; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "video_url": {
                            "description": "Direct MP4 URL; CDN links can expire; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "width": {
                            "description": "Video width in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "height": {
                            "description": "Video height in pixels; null when Instagram doesn't show it. Null doesn't mean zero.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "has_audio": {
                            "description": "Whether the reel has sound; null when not returned.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "user": {
                            "type": "object",
                            "properties": {
                              "pk": {
                                "type": "string",
                                "description": "The account's numeric Instagram id, as a string."
                              },
                              "username": {
                                "type": "string",
                                "description": "Instagram username, without @."
                              },
                              "full_name": {
                                "description": "Display name; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "profile_pic_url": {
                                "description": "Profile image URL; CDN links can expire; null when not returned.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "is_verified": {
                                "description": "Whether Instagram shows a verified badge; null when not returned.",
                                "type": [
                                  "boolean",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "pk",
                              "username",
                              "full_name",
                              "profile_pic_url",
                              "is_verified"
                            ],
                            "additionalProperties": false,
                            "description": "Reel author."
                          }
                        },
                        "required": [
                          "pk",
                          "code",
                          "url",
                          "caption",
                          "taken_at",
                          "like_count",
                          "comment_count",
                          "play_count",
                          "display_url",
                          "video_url",
                          "width",
                          "height",
                          "has_audio",
                          "user"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Reels in Instagram's ranking for this keyword."
                    },
                    "cursor": {
                      "description": "Pass it as `cursor` for the next page; null when not returned.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "has_more": {
                      "type": "boolean",
                      "description": "Whether there's another page. False on the last page."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "query",
                    "reels",
                    "cursor",
                    "has_more"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instagram/profile/similar": {
      "get": {
        "operationId": "instagram_similar_profiles",
        "tags": [
          "Instagram"
        ],
        "summary": "Similar profiles",
        "description": "The accounts Instagram suggests alongside a public profile.\n\nUse it to find accounts like one you know, for influencer discovery or competitor lists. Pass a username or profile URL. You get the accounts Instagram suggests to visitors of that profile, usually about 50, in Instagram's order.\n\nAccounts that turned off suggestions (nike, for one) return an empty list.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/instagram/similar-profiles"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "username",
            "in": "query",
            "required": false,
            "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
            "schema": {
              "description": "Instagram username, with or without @ (e.g. `nike`), or a profile URL. Required unless you pass `url`.",
              "type": "string",
              "maxLength": 2048
            },
            "example": "natgeo"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
            "schema": {
              "description": "An instagram.com profile URL, e.g. `https://www.instagram.com/nike/`. Required unless you pass `username`.",
              "type": "string",
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The accounts Instagram suggests alongside a public profile.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "profiles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "pk": {
                            "type": "string",
                            "description": "The account's numeric Instagram id, as a string."
                          },
                          "username": {
                            "type": "string",
                            "description": "Instagram username, without @."
                          },
                          "full_name": {
                            "description": "Display name; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "profile_pic_url": {
                            "description": "Profile image URL; CDN links can expire; null when not returned.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "is_verified": {
                            "description": "Whether Instagram shows a verified badge; null when not returned.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          },
                          "is_private": {
                            "description": "Whether the account is private; null when not returned.",
                            "type": [
                              "boolean",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "pk",
                          "username",
                          "full_name",
                          "profile_pic_url",
                          "is_verified",
                          "is_private"
                        ],
                        "additionalProperties": false,
                        "description": "One suggested account."
                      },
                      "description": "Suggested accounts in Instagram's order; empty when Instagram suggests none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "profiles"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/profile": {
      "get": {
        "operationId": "linkedin_profile",
        "tags": [
          "LinkedIn"
        ],
        "summary": "LinkedIn profile",
        "description": "A member's public profile: headline, about, experience, education, latest posts and articles.\n\nUse it to look up a person: name, location, photo, follower and connection counts, About, experience, education and latest posts. Pass their profile URL. You get what LinkedIn shows a logged-out visitor, and that depends on the member.\n\nFor most members, LinkedIn shows the name, location, photo, follower and connection counts, the start of About, the current company, some schools and the latest posts. It hides their headline and blurs the rest of their work history. `experienceHidden` says when that happened, and no logged-out request can read what's hidden. Creators and public figures also show their headline, full experience with descriptions, and education with degrees. Hidden values are null, never asterisks.\n\nLinkedIn answers a profile it won't show logged-out visitors exactly like one that doesn't exist, so both return `not_public`. Check the URL if you expected a public profile.\n\nContact info and activity beyond the latest posts need a login. Skills, certifications, volunteering and recommendations aren't included.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/profile"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public profile URL, e.g. https://www.linkedin.com/in/williamhgates. Country subdomains such as uk.linkedin.com work too.",
            "schema": {
              "description": "Public profile URL, e.g. https://www.linkedin.com/in/williamhgates. Country subdomains such as uk.linkedin.com work too.",
              "type": "string"
            },
            "example": "https://www.linkedin.com/in/williamhgates"
          }
        ],
        "responses": {
          "200": {
            "description": "A member's public profile: headline, about, experience, education, latest posts and articles.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "description": "LinkedIn member id, when the page exposes it.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "description": "Canonical public profile URL."
                    },
                    "name": {
                      "type": "string",
                      "description": "Member's full name."
                    },
                    "headline": {
                      "description": "Headline under the name, e.g. their role and company. Null when LinkedIn hides it, as it does for members whose work history it blurs.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "location": {
                      "description": "Location as LinkedIn shows it, e.g. Seattle, Washington, United States.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "countryCode": {
                      "description": "Two-letter country code from the profile's address.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "image": {
                      "description": "Profile photo URL; may expire.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "coverImage": {
                      "description": "Background banner URL; may expire.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "followers": {
                      "description": "Exact follower count.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "connections": {
                      "description": "Connections LinkedIn shows. It shows 500 or more as 500+, returned as 500.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "about": {
                      "description": "The About section. LinkedIn cuts it short, ending in …, for most members.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "experienceHidden": {
                      "type": "boolean",
                      "description": "True when LinkedIn blurs this member's work history for logged-out visitors, as it does for most members. `experience` then holds only the current positions LinkedIn reveals, with hidden titles as null."
                    },
                    "experience": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "title": {
                            "description": "Job title; null when LinkedIn hides it.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "company": {
                            "description": "Company or organization name.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "companyUrl": {
                            "description": "The organization's LinkedIn page.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "companyLogo": {
                            "description": "Organization logo URL; may expire.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "location": {
                            "description": "Where the role is based, when shown.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "startDate": {
                            "description": "Start of the role: YYYY-MM, or YYYY when LinkedIn shows only the year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "endDate": {
                            "description": "End of the role: null while it's current or when not shown; YYYY-MM, or YYYY when LinkedIn shows only the year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "duration": {
                            "description": "Tenure as LinkedIn shows it, e.g. 12 years 9 months.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "description": {
                            "description": "The role's description, when public.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "title",
                          "company",
                          "companyUrl",
                          "companyLogo",
                          "location",
                          "startDate",
                          "endDate",
                          "duration",
                          "description"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Positions in LinkedIn's order, newest first. Hidden entries are left out."
                    },
                    "education": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "school": {
                            "type": "string",
                            "description": "School name."
                          },
                          "url": {
                            "description": "The school's LinkedIn page.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "logo": {
                            "description": "School logo URL; may expire.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "degree": {
                            "description": "Degree, e.g. Bachelor's Degree.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "field": {
                            "description": "Field of study.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "startDate": {
                            "description": "Start: YYYY-MM, or YYYY when LinkedIn shows only the year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "endDate": {
                            "description": "End: YYYY-MM, or YYYY when LinkedIn shows only the year.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "school",
                          "url",
                          "logo",
                          "degree",
                          "field",
                          "startDate",
                          "endDate"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Education in LinkedIn's order. Hidden entries are left out."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Activity id, kept as a string to preserve all digits."
                          },
                          "url": {
                            "type": "string",
                            "description": "Public post URL."
                          },
                          "text": {
                            "type": "string",
                            "description": "Post text. Empty when the post only contains media."
                          },
                          "datePublished": {
                            "description": "Publication time in UTC.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "likeCount": {
                            "description": "Reactions LinkedIn shows.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "text",
                          "datePublished",
                          "likeCount"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The member's latest public posts and reposts with commentary that LinkedIn shows on the profile, usually up to 8. Not a complete history."
                    },
                    "articles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "title": {
                            "type": "string",
                            "description": "Article headline."
                          },
                          "url": {
                            "type": "string",
                            "description": "Article URL on linkedin.com/pulse."
                          },
                          "datePublished": {
                            "description": "Publication time in UTC.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "likeCount": {
                            "description": "Reactions LinkedIn shows.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "image": {
                            "description": "Cover image URL; may expire.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "title",
                          "url",
                          "datePublished",
                          "likeCount",
                          "image"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Newsletter and long-form articles the member published, latest first, as many as the profile shows (often up to 10)."
                    },
                    "similarProfiles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Member's name."
                          },
                          "url": {
                            "type": "string",
                            "description": "Their public profile URL."
                          },
                          "headline": {
                            "description": "Their headline or current company, as the card shows it.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "location": {
                            "description": "Their location.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "image": {
                            "description": "Profile photo URL; may expire.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "name",
                          "url",
                          "headline",
                          "location",
                          "image"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Other profiles LinkedIn suggests next to this one. Empty when the page has none."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "name",
                    "headline",
                    "location",
                    "countryCode",
                    "image",
                    "coverImage",
                    "followers",
                    "connections",
                    "about",
                    "experienceHidden",
                    "experience",
                    "education",
                    "posts",
                    "articles",
                    "similarProfiles"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/company": {
      "get": {
        "operationId": "linkedin_company",
        "tags": [
          "LinkedIn"
        ],
        "summary": "LinkedIn company page",
        "description": "A company's public page: overview, size, industry, headquarters and latest updates.\n\nUse it to look up a company: tagline, About text, website, industry, size, headquarters, specialties and latest updates. Pass its LinkedIn page URL. Its `id` filters job search (linkedin_search_jobs) to this company.\n\nYou get the public page a logged-out visitor sees, and missing fields are null. Employee profiles, funding details and the full About tab aren't included. If LinkedIn asks us to sign in or shows a challenge, the call fails with `upstream_error` (free) instead of returning an empty company.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/company"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A LinkedIn company page URL, e.g. https://www.linkedin.com/company/hubspot/. Use the main page, not a subpage like /jobs/ or /about/.",
            "schema": {
              "description": "A LinkedIn company page URL, e.g. https://www.linkedin.com/company/hubspot/. Use the main page, not a subpage like /jobs/ or /about/.",
              "type": "string"
            },
            "example": "https://www.linkedin.com/company/hubspot/"
          }
        ],
        "responses": {
          "200": {
            "description": "A company's public page: overview, size, industry, headquarters and latest updates.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "description": "LinkedIn organization id, when exposed on the public page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "description": "Canonical public LinkedIn company page URL."
                    },
                    "name": {
                      "type": "string",
                      "description": "Company name."
                    },
                    "tagline": {
                      "description": "Company's short tagline.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description": {
                      "description": "Public About us text.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "website": {
                      "description": "External website published by the company.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "logo": {
                      "description": "Company logo URL; may expire.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "industry": {
                      "description": "Industry category shown by LinkedIn.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "size": {
                      "description": "Company headcount range as LinkedIn displays it, e.g. 5,001-10,000 employees.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "employeeCount": {
                      "description": "LinkedIn members associated with the company. It can differ from the size range the company states (`size`).",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "followers": {
                      "description": "Followers of the company page, when published.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "founded": {
                      "description": "Founding year published by the company.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "headquarters": {
                      "description": "Headquarters location as displayed by LinkedIn.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "type": {
                      "description": "Organization type, e.g. Public Company.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "specialties": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Company specialties listed on the public page."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Activity id of this update, kept as a string to preserve all digits."
                          },
                          "url": {
                            "type": "string",
                            "description": "Public post URL or activity permalink."
                          },
                          "text": {
                            "type": "string",
                            "description": "The update's public text. Empty when the card only contains media."
                          },
                          "datePublished": {
                            "description": "When it was posted, in UTC. `dateSource` says where the time comes from.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "dateSource": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "published",
                                  "activity_id"
                                ]
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "`published`: LinkedIn states the time. `activity_id`: we read it from the update's id, which gives the post time for originals and the repost time for reposts. Null when unavailable."
                          },
                          "likeCount": {
                            "description": "Total reactions LinkedIn shows, not only likes; null when hidden.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "commentCount": {
                            "description": "Number of comments LinkedIn shows; null when hidden.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Images in the update, in order; the links expire. Empty for video-only or document-only updates (document pages are in `document`)."
                          },
                          "video": {
                            "description": "A publicly playable video URL from the card, or null. URLs may expire.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "document": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "title": {
                                    "description": "Document title.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "pageCount": {
                                    "description": "Number of pages LinkedIn reports for the document.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "pageImages": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    },
                                    "description": "Preview images of the first pages, in order. LinkedIn previews a few pages, not all. URLs may expire."
                                  }
                                },
                                "required": [
                                  "title",
                                  "pageCount",
                                  "pageImages"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "An attached document (PDF or slides), or null."
                          },
                          "reposted": {
                            "type": "boolean",
                            "description": "True when LinkedIn explicitly marks this update as a repost."
                          },
                          "resharedPost": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Activity id of the original post."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Activity permalink of the original post."
                                  },
                                  "author": {
                                    "type": "object",
                                    "properties": {
                                      "name": {
                                        "description": "Author name.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "url": {
                                        "description": "Author's LinkedIn profile or page URL.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "name",
                                      "url"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Who published the original post."
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "The original post's text. Empty when it only contains media."
                                  },
                                  "datePublished": {
                                    "description": "Publication time in UTC, decoded from the original's activity id.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "images": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    },
                                    "description": "Images in the original post, in source order. URLs may expire."
                                  },
                                  "video": {
                                    "description": "A publicly playable video URL from the original post, or null. URLs may expire.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "document": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "description": "Document title.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "pageCount": {
                                            "description": "Number of pages LinkedIn reports for the document.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          },
                                          "pageImages": {
                                            "type": "array",
                                            "items": {
                                              "type": "string"
                                            },
                                            "description": "Preview images of the first pages, in order. LinkedIn previews a few pages, not all. URLs may expire."
                                          }
                                        },
                                        "required": [
                                          "title",
                                          "pageCount",
                                          "pageImages"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "An attached document (PDF or slides), or null."
                                  }
                                },
                                "required": [
                                  "id",
                                  "url",
                                  "author",
                                  "text",
                                  "datePublished",
                                  "images",
                                  "video",
                                  "document"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The original post, when this update reposts it with commentary and embeds it; null otherwise. A plain repost has `reposted: true` and shows the original as the update itself."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "text",
                          "datePublished",
                          "dateSource",
                          "likeCount",
                          "commentCount",
                          "images",
                          "video",
                          "document",
                          "reposted",
                          "resharedPost"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The latest updates, reposts included, in LinkedIn's order. Usually up to 12, not the full history."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "name",
                    "tagline",
                    "description",
                    "website",
                    "logo",
                    "industry",
                    "size",
                    "employeeCount",
                    "followers",
                    "founded",
                    "headquarters",
                    "type",
                    "specialties",
                    "posts"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/company/posts": {
      "get": {
        "operationId": "linkedin_company_posts",
        "tags": [
          "LinkedIn"
        ],
        "summary": "LinkedIn company posts",
        "description": "Latest public updates from a company page, with text, engagement and media.\n\nUse it to see what a company posts on LinkedIn: each update's text, reactions, comment count, images, video and document previews. Pass the company page URL. You get the latest updates its public page shows, usually up to 12, reposts included.\n\nThere are no further pages, so `page` must be 1. LinkedIn's public feed can repeat the first page, and older posts need a login.\n\nLinkedIn sometimes serves the page without its updates. Then we fetch it once more, and an empty answer is cached for only 5 minutes. Reshared posts, documents and full comment threads aren't opened.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/company-posts"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "A LinkedIn company page URL, e.g. https://www.linkedin.com/company/hubspot/. Use the main page, not a subpage like /jobs/ or /about/.",
            "schema": {
              "description": "A LinkedIn company page URL, e.g. https://www.linkedin.com/company/hubspot/. Use the main page, not a subpage like /jobs/ or /about/.",
              "type": "string"
            },
            "example": "https://www.linkedin.com/company/hubspot/"
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Always 1. The latest updates are the only page LinkedIn shows logged-out visitors.",
            "schema": {
              "default": 1,
              "description": "Always 1. The latest updates are the only page LinkedIn shows logged-out visitors.",
              "type": "integer",
              "minimum": 1,
              "maximum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Latest public updates from a company page, with text, engagement and media.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "company": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "description": "Organization id, when exposed.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "name": {
                          "type": "string",
                          "description": "Company name."
                        },
                        "url": {
                          "type": "string",
                          "description": "Canonical company page URL."
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "url"
                      ],
                      "additionalProperties": false,
                      "description": "Company whose latest updates are listed."
                    },
                    "posts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Activity id of this update, kept as a string to preserve all digits."
                          },
                          "url": {
                            "type": "string",
                            "description": "Public post URL or activity permalink."
                          },
                          "text": {
                            "type": "string",
                            "description": "The update's public text. Empty when the card only contains media."
                          },
                          "datePublished": {
                            "description": "When it was posted, in UTC. `dateSource` says where the time comes from.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "dateSource": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "published",
                                  "activity_id"
                                ]
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "`published`: LinkedIn states the time. `activity_id`: we read it from the update's id, which gives the post time for originals and the repost time for reposts. Null when unavailable."
                          },
                          "likeCount": {
                            "description": "Total reactions LinkedIn shows, not only likes; null when hidden.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "commentCount": {
                            "description": "Number of comments LinkedIn shows; null when hidden.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Images in the update, in order; the links expire. Empty for video-only or document-only updates (document pages are in `document`)."
                          },
                          "video": {
                            "description": "A publicly playable video URL from the card, or null. URLs may expire.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "document": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "title": {
                                    "description": "Document title.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "pageCount": {
                                    "description": "Number of pages LinkedIn reports for the document.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "pageImages": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    },
                                    "description": "Preview images of the first pages, in order. LinkedIn previews a few pages, not all. URLs may expire."
                                  }
                                },
                                "required": [
                                  "title",
                                  "pageCount",
                                  "pageImages"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "An attached document (PDF or slides), or null."
                          },
                          "reposted": {
                            "type": "boolean",
                            "description": "True when LinkedIn explicitly marks this update as a repost."
                          },
                          "resharedPost": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Activity id of the original post."
                                  },
                                  "url": {
                                    "type": "string",
                                    "description": "Activity permalink of the original post."
                                  },
                                  "author": {
                                    "type": "object",
                                    "properties": {
                                      "name": {
                                        "description": "Author name.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      },
                                      "url": {
                                        "description": "Author's LinkedIn profile or page URL.",
                                        "type": [
                                          "string",
                                          "null"
                                        ]
                                      }
                                    },
                                    "required": [
                                      "name",
                                      "url"
                                    ],
                                    "additionalProperties": false,
                                    "description": "Who published the original post."
                                  },
                                  "text": {
                                    "type": "string",
                                    "description": "The original post's text. Empty when it only contains media."
                                  },
                                  "datePublished": {
                                    "description": "Publication time in UTC, decoded from the original's activity id.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "images": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    },
                                    "description": "Images in the original post, in source order. URLs may expire."
                                  },
                                  "video": {
                                    "description": "A publicly playable video URL from the original post, or null. URLs may expire.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "document": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "description": "Document title.",
                                            "type": [
                                              "string",
                                              "null"
                                            ]
                                          },
                                          "pageCount": {
                                            "description": "Number of pages LinkedIn reports for the document.",
                                            "type": [
                                              "number",
                                              "null"
                                            ]
                                          },
                                          "pageImages": {
                                            "type": "array",
                                            "items": {
                                              "type": "string"
                                            },
                                            "description": "Preview images of the first pages, in order. LinkedIn previews a few pages, not all. URLs may expire."
                                          }
                                        },
                                        "required": [
                                          "title",
                                          "pageCount",
                                          "pageImages"
                                        ],
                                        "additionalProperties": false
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "An attached document (PDF or slides), or null."
                                  }
                                },
                                "required": [
                                  "id",
                                  "url",
                                  "author",
                                  "text",
                                  "datePublished",
                                  "images",
                                  "video",
                                  "document"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The original post, when this update reposts it with commentary and embeds it; null otherwise. A plain repost has `reposted: true` and shows the original as the update itself."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "text",
                          "datePublished",
                          "dateSource",
                          "likeCount",
                          "commentCount",
                          "images",
                          "video",
                          "document",
                          "reposted",
                          "resharedPost"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The latest updates, in LinkedIn's order."
                    },
                    "paginationAvailable": {
                      "type": "boolean",
                      "const": false,
                      "description": "Always false, since there's no reliable way to page further."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "company",
                    "posts",
                    "paginationAvailable"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/jobs/search": {
      "get": {
        "operationId": "linkedin_search_jobs",
        "tags": [
          "LinkedIn"
        ],
        "summary": "Search LinkedIn jobs",
        "description": "Job listings by keyword and location, optionally only recent ones or one company's.\n\nUse it to see who's hiring for a role, or to track one company's openings. Each listing has the title, company, location and listing date. For the description, criteria and applicant count, use job details (linkedin_job).\n\nFilter by `location`, `datePosted` and `companyId` (the `id` from the company endpoint). Without `location`, LinkedIn picks one in the United States based on where our servers are. Job type, experience level, workplace and sort aren't offered, because LinkedIn ignores them for logged-out visitors.\n\nLinkedIn never reports zero matches. A query that matches nothing returns broader suggestions, often jobs near the location, so check titles when precision matters.\n\n**Pagination.** 10 listings per page, LinkedIn's own page size. Pass `cursor` from the previous answer for the next 10, up to 1,000 listings. `cursor` is null on the last page.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/search-jobs"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Job title, skill or keywords, e.g. software engineer.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Job title, skill or keywords, e.g. software engineer."
            },
            "example": "software engineer"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "City, region or country, e.g. United States, London or Berlin, Germany.",
            "schema": {
              "description": "City, region or country, e.g. United States, London or Berlin, Germany.",
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "example": "United States"
          },
          {
            "name": "datePosted",
            "in": "query",
            "required": false,
            "description": "Only jobs listed in the past 24 hours, week or month.",
            "schema": {
              "description": "Only jobs listed in the past 24 hours, week or month.",
              "default": "any",
              "type": "string",
              "enum": [
                "any",
                "past-24h",
                "past-week",
                "past-month"
              ]
            }
          },
          {
            "name": "companyId",
            "in": "query",
            "required": false,
            "description": "Only this company's jobs: the numeric `id` from the company endpoint, e.g. 68529 for HubSpot.",
            "schema": {
              "description": "Only this company's jobs: the numeric `id` from the company endpoint, e.g. 68529 for HubSpot.",
              "type": "string",
              "pattern": "^\\d{1,15}$"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The `cursor` from the previous response, for the next page. Keep every other param the same.",
            "schema": {
              "description": "The `cursor` from the previous response, for the next page. Keep every other param the same.",
              "type": "string",
              "pattern": "^\\d{1,3}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Job listings by keyword and location, optionally only recent ones or one company's.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "jobs": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "LinkedIn job id. Pass it to job details."
                          },
                          "url": {
                            "type": "string",
                            "description": "Public job page."
                          },
                          "title": {
                            "type": "string",
                            "description": "Job title."
                          },
                          "company": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "description": "Company name.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "url": {
                                "description": "The company's LinkedIn page.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "logo": {
                                "description": "Company logo URL; may expire.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "name",
                              "url",
                              "logo"
                            ],
                            "additionalProperties": false,
                            "description": "Hiring company."
                          },
                          "location": {
                            "description": "Location as LinkedIn shows it, e.g. Warren, MI or United States.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "listedAt": {
                            "description": "Day the job was listed, YYYY-MM-DD.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "insight": {
                            "description": "LinkedIn's note on the card, e.g. Actively Hiring or Be an early applicant.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "title",
                          "company",
                          "location",
                          "listedAt",
                          "insight"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Listings in LinkedIn's order."
                    },
                    "cursor": {
                      "description": "Pass as `cursor` for the next page. null on the last page.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "jobs",
                    "cursor"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/job": {
      "get": {
        "operationId": "linkedin_job",
        "tags": [
          "LinkedIn"
        ],
        "summary": "LinkedIn job details",
        "description": "One job listing's description, criteria and applicant count.\n\nUse it to read a job listing in full: title, company, location, how long ago it was posted, the applicant count, the full description and LinkedIn's criteria (seniority, employment type, industries). Pass a job URL, or the `id` from job search, as `url`.\n\nThe description comes as plain text, with list items as `- ` lines. For the exact listing date, see `listedAt` in job search. A listing LinkedIn no longer has returns 404 `not_found`.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/job"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Job URL such as https://www.linkedin.com/jobs/view/4419969671, or just the job id.",
            "schema": {
              "description": "Job URL such as https://www.linkedin.com/jobs/view/4419969671, or just the job id.",
              "type": "string"
            },
            "example": "https://www.linkedin.com/jobs/view/4415336738"
          }
        ],
        "responses": {
          "200": {
            "description": "One job listing's description, criteria and applicant count.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "LinkedIn job id."
                    },
                    "url": {
                      "type": "string",
                      "description": "Public job page."
                    },
                    "title": {
                      "type": "string",
                      "description": "Job title."
                    },
                    "company": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "description": "Company name.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "url": {
                          "description": "The company's LinkedIn page.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "logo": {
                          "description": "Company logo URL; may expire.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "name",
                        "url",
                        "logo"
                      ],
                      "additionalProperties": false,
                      "description": "Hiring company."
                    },
                    "location": {
                      "description": "Location as LinkedIn shows it.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "postedAgo": {
                      "description": "How long ago it was posted, as LinkedIn shows it, e.g. 2 weeks ago.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "applicants": {
                      "description": "Applicant count as LinkedIn shows it, e.g. 195 applicants or Over 200 applicants.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description": {
                      "type": "string",
                      "description": "The full description as plain text; list items start with `- `."
                    },
                    "seniority": {
                      "description": "Seniority level, e.g. Mid-Senior level.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "employmentType": {
                      "description": "Employment type, e.g. Full-time.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "industries": {
                      "description": "Industries, as one comma-separated line.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "title",
                    "company",
                    "location",
                    "postedAgo",
                    "applicants",
                    "description",
                    "seniority",
                    "employmentType",
                    "industries"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/ads/search": {
      "get": {
        "operationId": "linkedin_search_ads",
        "tags": [
          "LinkedIn"
        ],
        "summary": "Search LinkedIn ads",
        "description": "Search LinkedIn's public Ad Library by advertiser or keyword.\n\nUse it to see the ads a company runs on LinkedIn, or ads that mention a word. Pass `company` (the advertiser's name), `keyword`, or both. You get up to about 24 ad previews per page.\n\nPreviews can cut the ad text short. For one ad's full copy, payer and delivery details, pass its `adLibraryUrl` to ad details (linkedin_ad).\n\nFilter by `countries` (comma-separated codes like DE,FR) and a date range (`startDate` and `endDate`, YYYY-MM-DD). LinkedIn covers roughly the last year. What it publishes about delivery and targeting depends on the ad and the region.\n\n**Pagination.** Pass `paginationToken` back with the same filters for the next page. `isLastPage` is true on the last page, and `total` is null after the first. If LinkedIn blocks a request, the call fails with `upstream_error`, which is free.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/search-ads"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "company",
            "in": "query",
            "required": false,
            "description": "Advertiser name to search, e.g. HubSpot.",
            "schema": {
              "description": "Advertiser name to search, e.g. HubSpot.",
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          },
          {
            "name": "keyword",
            "in": "query",
            "required": false,
            "description": "Words in the ad copy.",
            "schema": {
              "description": "Words in the ad copy.",
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "example": "hubspot"
          },
          {
            "name": "countries",
            "in": "query",
            "required": false,
            "description": "Only ads delivered in these countries, as comma-separated two-letter codes such as DE,FR. EU is not supported as a country filter.",
            "schema": {
              "description": "Only ads delivered in these countries, as comma-separated two-letter codes such as DE,FR. EU is not supported as a country filter.",
              "type": "string",
              "pattern": "^[A-Z]{2}(,[A-Z]{2}){0,9}$"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": false,
            "description": "Start of the date range, YYYY-MM-DD. Pass `endDate` too. LinkedIn covers roughly the past year.",
            "schema": {
              "description": "Start of the date range, YYYY-MM-DD. Pass `endDate` too. LinkedIn covers roughly the past year.",
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            }
          },
          {
            "name": "endDate",
            "in": "query",
            "required": false,
            "description": "End of the date range, YYYY-MM-DD. Pass `startDate` too.",
            "schema": {
              "description": "End of the date range, YYYY-MM-DD. Pass `startDate` too.",
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            }
          },
          {
            "name": "paginationToken",
            "in": "query",
            "required": false,
            "description": "Token from the previous page. Keep company, keyword, countries and dates the same.",
            "schema": {
              "description": "Token from the previous page. Keep company, keyword, countries and dates the same.",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search LinkedIn's public Ad Library by advertiser or keyword.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "ads": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "LinkedIn Ad Library ad id."
                          },
                          "adLibraryUrl": {
                            "type": "string",
                            "description": "Public detail page for this ad."
                          },
                          "advertiser": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "description": "Advertiser name shown on the preview.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "url": {
                                "description": "Advertiser's LinkedIn page. Ad details only; search previews don't link it.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "name",
                              "url"
                            ],
                            "additionalProperties": false,
                            "description": "The advertiser shown on the ad."
                          },
                          "creativeType": {
                            "description": "The ad type, as LinkedIn's raw code.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "format": {
                            "description": "The ad format in plain words, as LinkedIn shows it, when available.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "text": {
                            "description": "Visible ad copy, or the message body for message ads. Search previews may truncate it; use ad details for the full public copy.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "headline": {
                            "description": "Ad headline when the preview exposes one: the event name for event ads, the document title for document ads.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "images": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Preview, carousel and document page image URLs in source order. URLs can expire."
                          },
                          "videos": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "url": {
                                  "type": "string",
                                  "description": "Playable video source URL."
                                },
                                "bitrate": {
                                  "description": "Source bitrate in bits per second when supplied by LinkedIn.",
                                  "type": [
                                    "number",
                                    "null"
                                  ]
                                }
                              },
                              "required": [
                                "url",
                                "bitrate"
                              ],
                              "additionalProperties": false
                            },
                            "description": "Video variants from ad details, or an empty list. Search previews have none; their poster is in images."
                          },
                          "cta": {
                            "description": "Call-to-action button text. Ad details only; search previews don't show it.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "message": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "sender": {
                                    "description": "Member shown as the message's sender.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "buttons": {
                                    "anyOf": [
                                      {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        }
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "Button labels in order. Ad details only; null in search previews."
                                  }
                                },
                                "required": [
                                  "sender",
                                  "buttons"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Message ad details; null for other formats."
                          },
                          "event": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "date": {
                                    "description": "Event start time exactly as LinkedIn shows it, e.g. September 15, 2026, 4:55 PM UTC.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "location": {
                                    "description": "Where the event takes place as LinkedIn shows it, e.g. Online.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "date",
                                  "location"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Event ad details; null for other formats."
                          },
                          "carouselCards": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "title": {
                                      "description": "Card title.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "image": {
                                      "description": "Card image URL. URLs can expire.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "title",
                                    "image"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Carousel cards in order; null for other formats."
                          }
                        },
                        "required": [
                          "id",
                          "adLibraryUrl",
                          "advertiser",
                          "creativeType",
                          "format",
                          "text",
                          "headline",
                          "images",
                          "videos",
                          "cta",
                          "message",
                          "event",
                          "carouselCards"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Ad previews in LinkedIn's search order."
                    },
                    "total": {
                      "description": "Total matching ads, when shown on the first search page; null on fragments without a count.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "paginationToken": {
                      "description": "Token for the next page; null when LinkedIn supplies none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "isLastPage": {
                      "type": "boolean",
                      "description": "True when LinkedIn reports the final page or a confirmed empty search."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "ads",
                    "total",
                    "paginationToken",
                    "isLastPage"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linkedin/ad": {
      "get": {
        "operationId": "linkedin_ad",
        "tags": [
          "LinkedIn"
        ],
        "summary": "LinkedIn ad details",
        "description": "One LinkedIn ad's creative, payer and public delivery disclosures.\n\nUse it to read one ad in full: its creative, who paid for it, when it ran, and its impressions and targeting where LinkedIn publishes them. Pass the `adLibraryUrl` from ad search (linkedin_search_ads).\n\nLinkedIn mostly publishes these details for ads shown in the EU, so elsewhere they're often missing. Counts and dates come as LinkedIn writes them; we don't guess exact values. When LinkedIn hides the ad's preview, `restricted` is true, but its delivery details can still be there.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkedin/ad"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The ad's LinkedIn Ad Library URL, from `adLibraryUrl` in search ads, e.g. https://www.linkedin.com/ad-library/detail/1558746953.",
            "schema": {
              "description": "The ad's LinkedIn Ad Library URL, from `adLibraryUrl` in search ads, e.g. https://www.linkedin.com/ad-library/detail/1558746953.",
              "type": "string"
            },
            "example": "https://www.linkedin.com/ad-library/detail/1558746953"
          }
        ],
        "responses": {
          "200": {
            "description": "One LinkedIn ad's creative, payer and public delivery disclosures.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "LinkedIn Ad Library ad id."
                    },
                    "adLibraryUrl": {
                      "type": "string",
                      "description": "Public detail page for this ad."
                    },
                    "advertiser": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "description": "Advertiser name shown on the preview.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "url": {
                          "description": "Advertiser's LinkedIn page. Ad details only; search previews don't link it.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "name",
                        "url"
                      ],
                      "additionalProperties": false,
                      "description": "The advertiser shown on the ad."
                    },
                    "creativeType": {
                      "description": "The ad type, as LinkedIn's raw code.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "format": {
                      "description": "The ad format in plain words, as LinkedIn shows it, when available.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "text": {
                      "description": "Visible ad copy, or the message body for message ads. Search previews may truncate it; use ad details for the full public copy.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "headline": {
                      "description": "Ad headline when the preview exposes one: the event name for event ads, the document title for document ads.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "images": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Preview, carousel and document page image URLs in source order. URLs can expire."
                    },
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string",
                            "description": "Playable video source URL."
                          },
                          "bitrate": {
                            "description": "Source bitrate in bits per second when supplied by LinkedIn.",
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "url",
                          "bitrate"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Video variants from ad details, or an empty list. Search previews have none; their poster is in images."
                    },
                    "cta": {
                      "description": "Call-to-action button text. Ad details only; search previews don't show it.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "message": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "sender": {
                              "description": "Member shown as the message's sender.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "buttons": {
                              "anyOf": [
                                {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  }
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Button labels in order. Ad details only; null in search previews."
                            }
                          },
                          "required": [
                            "sender",
                            "buttons"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Message ad details; null for other formats."
                    },
                    "event": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "date": {
                              "description": "Event start time exactly as LinkedIn shows it, e.g. September 15, 2026, 4:55 PM UTC.",
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "location": {
                              "description": "Where the event takes place as LinkedIn shows it, e.g. Online.",
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "date",
                            "location"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Event ad details; null for other formats."
                    },
                    "carouselCards": {
                      "anyOf": [
                        {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "description": "Card title.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "image": {
                                "description": "Card image URL. URLs can expire.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "required": [
                              "title",
                              "image"
                            ],
                            "additionalProperties": false
                          }
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Carousel cards in order; null for other formats."
                    },
                    "payer": {
                      "description": "Organization paying for the ad, as disclosed by LinkedIn.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "availability": {
                      "description": "Ad run-date text exactly as LinkedIn shows it. Null when not disclosed.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "totalImpressions": {
                      "description": "Total impressions, as the number or range LinkedIn shows. Mostly published for ads shown in the EU.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "impressionsByCountry": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "country": {
                            "type": "string",
                            "description": "Country name or code shown in LinkedIn's breakdown."
                          },
                          "impressions": {
                            "description": "This country's share of impressions as LinkedIn shows it, e.g. 100%. It's a percentage, not a count.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "country",
                          "impressions"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Where the ad was shown, by country; empty when LinkedIn doesn't publish it."
                    },
                    "targeting": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "Targeting category LinkedIn shows, e.g. Language, Location, Audience or Company."
                          },
                          "value": {
                            "type": "string",
                            "description": "For Language and Location, the disclosed segments, e.g. Targeting includes Germany, France. For each parameter in LinkedIn's table (Audience, Company, Job…): Targeted, Excluded, Targeted and excluded, or Not used."
                          }
                        },
                        "required": [
                          "label",
                          "value"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Who the ad targeted: language and location first, then one row per targeting type. Mostly published for ads shown in the EU; empty otherwise."
                    },
                    "restricted": {
                      "type": "boolean",
                      "description": "True when LinkedIn hides the ad's preview. Delivery details can still be there."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "adLibraryUrl",
                    "advertiser",
                    "creativeType",
                    "format",
                    "text",
                    "headline",
                    "images",
                    "videos",
                    "cta",
                    "message",
                    "event",
                    "carouselCards",
                    "payer",
                    "availability",
                    "totalImpressions",
                    "impressionsByCountry",
                    "targeting",
                    "restricted"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/linktree": {
      "get": {
        "operationId": "linkinbio_linktree",
        "tags": [
          "Link-in-bio"
        ],
        "summary": "Linktree page",
        "description": "A public Linktree page: its links, social accounts and bio.\n\nUse it to find where a creator sends their audience: their website, social accounts, email and campaign links. Pass a `linktr.ee` profile URL. You get the title, bio, picture, categories, links and social accounts, in the page's order.\n\nCards that don't link anywhere, such as a header or an embedded shop, have `url: null`. Locked cards keep their destination hidden. We read the page only and don't follow its links.\n\nA missing page returns 404 `not_found`. A page behind a password or a sensitive-content warning returns 403 `not_public`. Results are cached for up to a day.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/linkinbio/linktree"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The creator's Linktree profile URL, such as https://linktr.ee/linktree. Tracking parameters are ignored.",
            "schema": {
              "description": "The creator's Linktree profile URL, such as https://linktr.ee/linktree. Tracking parameters are ignored.",
              "type": "string"
            },
            "example": "https://linktr.ee/miguelangeles"
          }
        ],
        "responses": {
          "200": {
            "description": "A public Linktree page: its links, social accounts and bio.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "integer",
                      "exclusiveMinimum": 0,
                      "maximum": 9007199254740991,
                      "description": "Linktree account id."
                    },
                    "username": {
                      "type": "string",
                      "description": "The profile's Linktree username."
                    },
                    "pageTitle": {
                      "type": "string",
                      "description": "Profile title; the username when no title is set."
                    },
                    "profilePictureUrl": {
                      "description": "Profile picture URL; null when no picture is set.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description": {
                      "description": "Profile bio as plain text; null when none is set.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "verticals": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Creator categories selected on Linktree, such as music or internet-technology."
                    },
                    "linkPlatforms": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Social platforms Linktree lists for the profile, in its order."
                    },
                    "timezone": {
                      "description": "The account's timezone; null when the page doesn't give one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "links": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "exclusiveMinimum": 0,
                            "maximum": 9007199254740991,
                            "description": "Link card id."
                          },
                          "type": {
                            "type": "string",
                            "description": "Linktree card type, such as CLASSIC, HEADER or YOUTUBE_VIDEO."
                          },
                          "title": {
                            "description": "Link card title; null if none is set.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "url": {
                            "description": "Where the card links; null for locked cards and cards that don't link anywhere.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "thumbnailUrl": {
                            "description": "Card thumbnail URL; null when none is set.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "locked": {
                            "type": "boolean",
                            "description": "Whether the card is locked. A locked card's destination is hidden."
                          },
                          "parentId": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "exclusiveMinimum": 0,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Id of the GROUP card this card sits in; null for top-level cards."
                          }
                        },
                        "required": [
                          "id",
                          "type",
                          "title",
                          "url",
                          "thumbnailUrl",
                          "locked",
                          "parentId"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Link cards in page order. Each GROUP card is followed by the cards inside it. Cards in hidden groups and embedded product details aren't included."
                    },
                    "socialLinks": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Linktree's social type, such as INSTAGRAM, TIKTOK or EMAIL_ADDRESS."
                          },
                          "url": {
                            "type": "string",
                            "description": "The social destination or mailto URL listed on the profile."
                          }
                        },
                        "required": [
                          "type",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The social links on the profile, in their displayed order."
                    },
                    "instagram": {
                      "description": "Instagram link; null if the profile doesn't list one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "tiktok": {
                      "description": "TikTok link; null if the profile doesn't list one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "spotify": {
                      "description": "Spotify link; null if the profile doesn't list one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "youtube": {
                      "description": "YouTube link; null if the profile doesn't list one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "soundcloud": {
                      "description": "SoundCloud link; null if the profile doesn't list one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "apple_music": {
                      "description": "Apple Music link; null if the profile doesn't list one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "email_address": {
                      "description": "Email address from the public EMAIL_ADDRESS social link, without mailto or query parameters; null when none is listed.",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "username",
                    "pageTitle",
                    "profilePictureUrl",
                    "description",
                    "verticals",
                    "linkPlatforms",
                    "timezone",
                    "links",
                    "socialLinks",
                    "instagram",
                    "tiktok",
                    "spotify",
                    "youtube",
                    "soundcloud",
                    "apple_music",
                    "email_address"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/ebay/search": {
      "get": {
        "operationId": "ebay_search",
        "tags": [
          "eBay"
        ],
        "summary": "Search eBay listings",
        "description": "Active eBay listings for a keyword, with price, bids, condition, shipping, seller and how many sold, filtered and sorted like ebay.com.\n\nUse it for price research and sourcing: what's listed, at what price, in what condition, and which listings sell. Filters work like eBay's own: `condition`, `buying_format`, `min_price` and `max_price`, `free_shipping` and `category_id`.\n\nThe price filters use the item price, without shipping. `category_id` is the number in an eBay category URL, or the `category_id` from listing details (ebay_item).\n\nResults match what ebay.com shows. Sponsored listings eBay places among the results are included; carousels and ads between them aren't. `sold` is how many units a listing has sold. It isn't a list of sold items, which eBay shows only to signed-in accounts.\n\n**Pagination.** 60 listings per page. Pass `next_page` as `page` for more. It's null on the last page.\n\nCost: 2 credits.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/ebay/search"
        },
        "x-credits": 2,
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Keywords, as typed into eBay's search box, e.g. `iphone 15 pro`.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 300,
              "description": "Keywords, as typed into eBay's search box, e.g. `iphone 15 pro`."
            },
            "example": "nintendo switch oled"
          },
          {
            "name": "condition",
            "in": "query",
            "required": false,
            "description": "`new`, `open_box`, `refurbished` (any refurbished grade), `used`, `for_parts`, or `any` (default).",
            "schema": {
              "description": "`new`, `open_box`, `refurbished` (any refurbished grade), `used`, `for_parts`, or `any` (default).",
              "default": "any",
              "type": "string",
              "enum": [
                "any",
                "new",
                "open_box",
                "refurbished",
                "used",
                "for_parts"
              ]
            }
          },
          {
            "name": "buying_format",
            "in": "query",
            "required": false,
            "description": "`buy_it_now`, `auction`, `best_offer` (accepts offers), or `any` (default).",
            "schema": {
              "description": "`buy_it_now`, `auction`, `best_offer` (accepts offers), or `any` (default).",
              "default": "any",
              "type": "string",
              "enum": [
                "any",
                "buy_it_now",
                "auction",
                "best_offer"
              ]
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "`best_match` (eBay's default), `ending_soonest`, `newly_listed`, `price_low` or `price_high` (price plus shipping).",
            "schema": {
              "description": "`best_match` (eBay's default), `ending_soonest`, `newly_listed`, `price_low` or `price_high` (price plus shipping).",
              "default": "best_match",
              "type": "string",
              "enum": [
                "best_match",
                "ending_soonest",
                "newly_listed",
                "price_low",
                "price_high"
              ]
            }
          },
          {
            "name": "min_price",
            "in": "query",
            "required": false,
            "description": "Lowest item price in US dollars, e.g. `100`.",
            "schema": {
              "description": "Lowest item price in US dollars, e.g. `100`.",
              "type": "number",
              "minimum": 0,
              "maximum": 10000000
            }
          },
          {
            "name": "max_price",
            "in": "query",
            "required": false,
            "description": "Highest item price in US dollars, e.g. `500`.",
            "schema": {
              "description": "Highest item price in US dollars, e.g. `500`.",
              "type": "number",
              "minimum": 0,
              "maximum": 10000000
            }
          },
          {
            "name": "free_shipping",
            "in": "query",
            "required": false,
            "description": "`true` keeps listings with free shipping only.",
            "schema": {
              "description": "`true` keeps listings with free shipping only.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "category_id",
            "in": "query",
            "required": false,
            "description": "An eBay category number, e.g. `9355` (Cell Phones & Smartphones).",
            "schema": {
              "description": "An eBay category number, e.g. `9355` (Cell Phones & Smartphones).",
              "type": "string",
              "pattern": "^\\d{1,10}$"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Page of results, 1–100; 60 listings each. Use `next_page` from the previous answer.",
            "schema": {
              "description": "Page of results, 1–100; 60 listings each. Use `next_page` from the previous answer.",
              "default": 1,
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Active eBay listings for a keyword, with price, bids, condition, shipping, seller and how many sold, filtered and sorted like ebay.com.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "total_results": {
                      "description": "Matching listings as eBay counts them, from \"40,000+ results\" (a rounded lower bound for big searches).",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Item id, e.g. `285090601008`. Pass it to eBay listing details (ebay_item) for specifics, seller and shipping."
                          },
                          "url": {
                            "type": "string",
                            "description": "The listing on ebay.com."
                          },
                          "title": {
                            "type": "string",
                            "description": "Listing title."
                          },
                          "subtitle": {
                            "description": "The lines under the title other than the condition: the seller's subtitle and key specifics, joined with ` · `.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "condition": {
                            "description": "Condition as the card shows it, e.g. \"Brand New\", \"Pre-Owned\", \"Good - Refurbished\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "image": {
                            "description": "Thumbnail URL (i.ebayimg.com).",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "price": {
                            "description": "Price (the low end of a range, for listings with variations), in US dollars; null when the card doesn't show it.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "price_max": {
                            "description": "The high end of a price range; null for a single price, in US dollars; null when the card doesn't show it.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "price_text": {
                            "description": "The price as shown, e.g. \"$189.99\" or \"$20.00 to $35.00\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "original_price": {
                            "description": "The struck-through earlier price on discounted listings, in US dollars; null when the card doesn't show it.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "format": {
                            "type": "string",
                            "enum": [
                              "auction",
                              "fixed_price"
                            ],
                            "description": "`auction` when the card shows bids, else `fixed_price`."
                          },
                          "bids": {
                            "description": "Bids so far, on auctions; null otherwise.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "time_left": {
                            "description": "Time left on auctions as shown, e.g. \"6d 23h\" or \"46m\"; null otherwise.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "best_offer": {
                            "type": "boolean",
                            "description": "The seller accepts offers."
                          },
                          "shipping_cost": {
                            "description": "Shipping to the US: 0 when free, in US dollars; null when the card doesn't show it.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "shipping_text": {
                            "description": "Shipping as shown, e.g. \"Free delivery in 2-4 days\" or \"+$8.99 delivery\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "location": {
                            "description": "Where the item ships from, e.g. \"United States\" or \"China\".",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "free_returns": {
                            "type": "boolean",
                            "description": "The card says free returns."
                          },
                          "sold": {
                            "description": "How many the listing has sold, from \"1,234 sold\" (a lower bound for \"99+ sold\"); null when not shown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "watchers": {
                            "description": "Watchers, from \"16+ watchers\" (a lower bound); null when not shown.",
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "seller": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "username": {
                                    "type": "string",
                                    "description": "The seller's eBay username."
                                  },
                                  "feedback_percent": {
                                    "description": "Positive feedback, percent, e.g. 99.8; null for a seller without ratings.",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  },
                                  "feedback_count": {
                                    "description": "Feedback score as the card shows it; eBay rounds large ones (42K → 42000).",
                                    "type": [
                                      "number",
                                      "null"
                                    ]
                                  }
                                },
                                "required": [
                                  "username",
                                  "feedback_percent",
                                  "feedback_count"
                                ],
                                "additionalProperties": false
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The seller, when the card shows one (eBay leaves it off some layouts)."
                          },
                          "badges": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Other labels on the card, e.g. \"New Listing\", \"Last one\", \"eBay Refurbished\", \"Authenticity Guarantee\", coupons."
                          }
                        },
                        "required": [
                          "id",
                          "url",
                          "title",
                          "subtitle",
                          "condition",
                          "image",
                          "price",
                          "price_max",
                          "price_text",
                          "original_price",
                          "format",
                          "bids",
                          "time_left",
                          "best_offer",
                          "shipping_cost",
                          "shipping_text",
                          "location",
                          "free_returns",
                          "sold",
                          "watchers",
                          "seller",
                          "badges"
                        ],
                        "additionalProperties": false
                      },
                      "description": "One page of listings, in `sort` order."
                    },
                    "page": {
                      "type": "number",
                      "description": "This page's number."
                    },
                    "next_page": {
                      "description": "Pass as `page` for the next 60 listings; null on the last page.",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "total_results",
                    "items",
                    "page",
                    "next_page"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/ebay/item": {
      "get": {
        "operationId": "ebay_item",
        "tags": [
          "eBay"
        ],
        "summary": "eBay listing details",
        "description": "One eBay listing by item id or URL: price, condition, quantity sold and available, seller and feedback, shipping, returns, photos and item specifics.\n\nUse it to track one listing's price and sales, or to enrich a search result. Pass the item id or any eBay listing URL (`/itm/…`, from any eBay site).\n\nFor listings with variations (sizes, colors, storage), price and quantity are the default variation's, as on ebay.com. Ended listings still work. They come with `ended: true`, the last price and the notice eBay shows, e.g. \"Bidding ended on Mon, Oct 19 at 4:02 PM.\"\n\nReturns 404 `not_found` when eBay has no such listing, and 403 `not_public` for adult listings, which eBay shows only to signed-in accounts.\n\nCost: 2 credits.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/ebay/item"
        },
        "x-credits": 2,
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Item id, e.g. `285090601008`. Required unless you pass `url`.",
            "schema": {
              "description": "Item id, e.g. `285090601008`. Required unless you pass `url`.",
              "type": "string"
            },
            "example": "285090601008"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "A listing URL, e.g. `https://www.ebay.com/itm/285090601008`.",
            "schema": {
              "description": "A listing URL, e.g. `https://www.ebay.com/itm/285090601008`.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One eBay listing by item id or URL: price, condition, quantity sold and available, seller and feedback, shipping, returns, photos and item specifics.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "id": {
                      "type": "string",
                      "description": "Item id."
                    },
                    "url": {
                      "type": "string",
                      "description": "The listing on ebay.com."
                    },
                    "title": {
                      "type": "string",
                      "description": "Listing title."
                    },
                    "price": {
                      "description": "Current price (the current bid on auctions), in `currency`.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "currency": {
                      "description": "The price's currency, e.g. USD; the seller's own currency on some international listings.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "price_text": {
                      "description": "The price as ebay.com shows it, e.g. \"US $189.99\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "original_price": {
                      "description": "The struck-through list price on discounted listings, in `currency`; null otherwise.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "format": {
                      "type": "string",
                      "enum": [
                        "auction",
                        "fixed_price"
                      ],
                      "description": "`auction` when the listing takes bids, else `fixed_price`."
                    },
                    "bids": {
                      "description": "Bids so far, on auctions; null otherwise.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "ends_at": {
                      "description": "When an auction ends, ISO 8601; null for fixed-price listings.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "best_offer": {
                      "type": "boolean",
                      "description": "The seller accepts offers."
                    },
                    "condition": {
                      "description": "Condition, e.g. \"New\", \"Used\", \"Pre-owned - Good\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "seller_notes": {
                      "description": "The seller's note on the condition; null without one.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "available": {
                      "description": "Quantity available: \"3 available\" → 3, \"Last one\" → 1, \"More than 10 available\" → 10 (a lower bound); null when not shown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "sold": {
                      "description": "How many this listing has sold, from \"10 sold\"; null when not shown.",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "ended": {
                      "type": "boolean",
                      "description": "The listing has ended (sold, ended by the seller, or out of time)."
                    },
                    "status": {
                      "description": "The notice eBay shows on ended listings, e.g. \"Bidding ended on Mon, Oct 19 at 4:02 PM.\"; null on live ones.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "has_variations": {
                      "type": "boolean",
                      "description": "The listing has variations (sizes, colors…); price and quantity are the default one's."
                    },
                    "seller": {
                      "type": "object",
                      "properties": {
                        "username": {
                          "description": "eBay username. Search by seller on eBay with it.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "name": {
                          "description": "The name the listing shows: the store name for eBay Stores, else the username.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "url": {
                          "description": "The seller's store or items page.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "feedback_percent": {
                          "description": "Positive feedback, percent, e.g. 99.8.",
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "feedback_count": {
                          "description": "Feedback score, e.g. 42027.",
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "username",
                        "name",
                        "url",
                        "feedback_percent",
                        "feedback_count"
                      ],
                      "additionalProperties": false,
                      "description": "Who sells it."
                    },
                    "shipping_cost": {
                      "description": "Shipping to the US in `currency`, 0 when free; null when eBay doesn't say (e.g. local pickup only).",
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "shipping_text": {
                      "description": "Shipping as shown, e.g. \"Free USPS Ground Advantage®.\"",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "location": {
                      "description": "Where the item is, e.g. \"Virginia Beach, Virginia, United States\".",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "returns": {
                      "description": "Return policy as shown, e.g. \"30 days returns. Seller pays for return shipping.\"",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "images": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Every listing photo, full size (up to 1600 px), in the seller's order."
                    },
                    "item_specifics": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {
                        "type": "string"
                      },
                      "description": "Item specifics as the seller filled them in, e.g. {\"Brand\": \"Apple\", \"Model\": \"iPhone 12 mini\"}. Condition is in `condition`."
                    },
                    "category": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Category path, broadest first, e.g. [\"Electronics\", \"Cell Phones & Accessories\", \"Cell Phones & Smartphones\"]; empty if eBay doesn't show it."
                    },
                    "category_id": {
                      "description": "The listing's category number; pass it as `category_id` to search eBay listings for similar ones.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "listed_at": {
                      "description": "When the listing started, ISO 8601.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description_url": {
                      "description": "The seller's description as its own HTML page (eBay loads it in a frame).",
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "id",
                    "url",
                    "title",
                    "price",
                    "currency",
                    "price_text",
                    "original_price",
                    "format",
                    "bids",
                    "ends_at",
                    "best_offer",
                    "condition",
                    "seller_notes",
                    "available",
                    "sold",
                    "ended",
                    "status",
                    "has_variations",
                    "seller",
                    "shipping_cost",
                    "shipping_text",
                    "location",
                    "returns",
                    "images",
                    "item_specifics",
                    "category",
                    "category_id",
                    "listed_at",
                    "description_url"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "not_public: The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "not_found: What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/scrape": {
      "get": {
        "operationId": "web_scrape",
        "tags": [
          "Web"
        ],
        "summary": "Scrape a page (Auto)",
        "description": "Any public page, trying the cheapest step first and stepping up only if the site blocks it. 1–24 credits.\n\nPass a `url` and get the page. Use it when you don't know what a site needs. Auto tries these steps in order, and you pay only for the one that got the page:\n\n1. **direct** and **static**: plain requests, made the way a browser makes them. 1 credit.\n\n2. **browser**: a real Chrome loads the page. For JavaScript challenges (Cloudflare, AWS WAF, Akamai, PerimeterX) and pages built entirely with JavaScript. No extra credits.\n\n3. **unblocker**: a browser on separate IPs, for sites that block our usual ones (DataDome and the like). It returns the HTML the site sent, before JavaScript runs. +3.\n\n4. **residential**: a residential IP, the kind a home internet connection uses. A last resort. +4.\n\n5. **browser_residential**: our browser on a residential IP. The last resort for pages that need a browser. +13.\n\n6. **captcha**: if a captcha still blocks our browser (Cloudflare Turnstile, DataDome's slider, reCAPTCHA), we solve it. +10, only when one is solved.\n\n**The price depends on the site**, from 1 to 24 credits. Every answer's `billing` says what the call cost and why.\n\n**To control the price**, call one step's own endpoint (`/v1/web/fetch`, `/v1/web/render` and so on) for a fixed price. To cap it, set `max_credits`, list the steps you accept in `/v1/web/custom`, or set `render` and `proxy` here. `render=false&proxy=static` never costs more than 1 credit. `render=true` always returns the page after its JavaScript ran, never through the unblocker.\n\n**What comes back.** `via` names the step that got the page, and `attempts` lists every step tried. `status` is the site's own HTTP status; a 404 page is charged like any other page. Use `format=markdown` for AI models: links, headings, lists and tables survive, scripts and styles don't. Add `main=true` to keep only the page's own content. Pages over 2 MB are cut off (`truncated`).\n\n**Repeat calls.** If a site needed a stronger step recently, Auto starts there for 15 minutes. Once we get past a site's wall, later calls reuse that pass, often as a plain request in a few seconds. Nothing is cached: every call fetches the page fresh.\n\n**Failures are free.** If every allowed step is blocked, or the site is down or answers with a 5xx error, the call fails with 502 `upstream_error` and costs nothing. The message says why. After a call is blocked at every allowed step, the same call fails at once, still free, for 5 minutes. Change `render` or `proxy` to try other steps.\n\n**Speed.** 1–3 seconds on most sites, 5–15 when our browser renders the page, 15–35 through the unblocker, and up to 85 on the slowest (a captcha solved, or a blocked first visit retried).\n\nCost: 1 credit; +3 if a browser on separate IPs gets it, +4 if it needs a residential IP, +13 if a browser renders it on a residential IP, +10 if a captcha is solved.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/scrape"
        },
        "x-credits": 1,
        "x-extra-credits": {
          "unblock": 3,
          "premium": 4,
          "premium_render": 13,
          "captcha": 10
        },
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "render",
            "in": "query",
            "required": false,
            "description": "`auto` uses a browser only when the page needs one: ours at no extra cost, or the unblocker (+3). `true` always uses our browser and returns the page after its JavaScript ran. `false` sticks to plain requests.",
            "schema": {
              "description": "`auto` uses a browser only when the page needs one: ours at no extra cost, or the unblocker (+3). `true` always uses our browser and returns the page after its JavaScript ran. `false` sticks to plain requests.",
              "default": "auto",
              "type": "string",
              "enum": [
                "auto",
                "true",
                "false"
              ]
            }
          },
          {
            "name": "proxy",
            "in": "query",
            "required": false,
            "description": "Which IPs to fetch from. `auto` uses our usual IPs and the unblocker, and a residential IP only when those are blocked (+4 when one is used, +13 with our browser). `static` never uses a residential IP. `residential` uses only residential IPs.",
            "schema": {
              "description": "Which IPs to fetch from. `auto` uses our usual IPs and the unblocker, and a residential IP only when those are blocked (+4 when one is used, +13 with our browser). `static` never uses a residential IP. `residential` uses only residential IPs.",
              "default": "auto",
              "type": "string",
              "enum": [
                "auto",
                "static",
                "residential"
              ]
            }
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "Fetch from a residential IP in this country, as a two-letter code like `us`, `gb` or `de`. Setting it means `proxy=residential` (+4).",
            "schema": {
              "description": "Fetch from a residential IP in this country, as a two-letter code like `us`, `gb` or `de`. Setting it means `proxy=residential` (+4).",
              "type": "string",
              "pattern": "^[a-zA-Z]{2}$"
            }
          },
          {
            "name": "captcha",
            "in": "query",
            "required": false,
            "description": "`true` solves a captcha that blocks the browser (+10, only when one is solved). `false` never pays for a solve.",
            "schema": {
              "description": "`true` solves a captcha that blocks the browser (+10, only when one is solved). `false` never pays for a solve.",
              "default": "true",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "wait_for",
            "in": "query",
            "required": false,
            "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`. Setting it renders the page in our browser.",
            "schema": {
              "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`. Setting it renders the page in our browser.",
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "wait",
            "in": "query",
            "required": false,
            "description": "Milliseconds to let the page settle after it loads, up to 10000. Setting it renders the page in our browser.",
            "schema": {
              "description": "Milliseconds to let the page settle after it loads, up to 10000. Setting it renders the page in our browser.",
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            }
          },
          {
            "name": "max_credits",
            "in": "query",
            "required": false,
            "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free. For example, `1` allows plain requests and our browser, and `4` the unblocker too, but no residential IP or captcha solve.",
            "schema": {
              "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free. For example, `1` allows plain requests and our browser, and `4` the unblocker too, but no residential IP or captcha solve.",
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Any public page, trying the cheapest step first and stepping up only if the site blocks it. 1–24 credits.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/fetch": {
      "get": {
        "operationId": "web_fetch",
        "tags": [
          "Web"
        ],
        "summary": "Fetch a page (plain request)",
        "description": "A page from one plain request, without running JavaScript. The cheapest step. 1 credit.\n\nPass a `url` and get the page as the site sends it, before any JavaScript runs. We request it the way a browser would. Most sites answer in 1–3 seconds, so start here. For pages built with JavaScript, use `render`.\n\nIf our browser got past a site's bot wall recently, this request reuses that pass, so it often works on walled sites too.\n\n**Price.** Always 1 credit, and only when the page comes back. If the site blocks this step or can't be reached, the call fails with 502 `upstream_error` and costs nothing. Then `/v1/web/scrape` (Auto) can try the other steps for you, or `/v1/web/custom` the ones you list.\n\nFor AI models, use `format=markdown`, and add `main=true` to keep only the page's own content. Pages over 2 MB are cut off (`truncated: true`). The [web scraping guide](/docs/web-scraping) explains each step.\n\nCost: 1 credit.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/fetch"
        },
        "x-credits": 1,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page from one plain request, without running JavaScript. The cheapest step. 1 credit.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/render": {
      "get": {
        "operationId": "web_render",
        "tags": [
          "Web"
        ],
        "summary": "Render a page (browser)",
        "description": "The page as a real Chrome browser shows it, after its JavaScript runs. Gets past JavaScript challenges. 1 credit.\n\nPass a `url`. A real Chrome browser loads the page, runs its JavaScript and returns it as you'd see it. Use it for pages built with JavaScript, and for sites that check visitors with a JavaScript challenge (Cloudflare, AWS WAF, Akamai, PerimeterX).\n\nIt clicks Cloudflare's Turnstile checkbox on its own. Set `captcha=true` to have harder captchas solved too. To wait until the part you need has loaded, pass `wait_for` (a CSS selector) or `wait` (milliseconds). Usually 5–15 seconds, or 20–30 when a captcha is solved.\n\n**Price.** Always 1 credit (+10 if you set `captcha=true` and a captcha is solved), and only when the page comes back. If the site blocks this step or can't be reached, the call fails with 502 `upstream_error` and costs nothing. Then `/v1/web/scrape` (Auto) can try the other steps for you, or `/v1/web/custom` the ones you list.\n\nFor AI models, use `format=markdown`, and add `main=true` to keep only the page's own content. Pages over 2 MB are cut off (`truncated: true`). The [web scraping guide](/docs/web-scraping) explains each step.\n\nCost: 1 credit; 11 if a captcha is solved.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/render"
        },
        "x-credits": 1,
        "x-extra-credits": {
          "captcha": 10
        },
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "captcha",
            "in": "query",
            "required": false,
            "description": "`true` lets us solve a captcha that blocks the browser (+10, only when one is solved). Off by default, so the price stays fixed.",
            "schema": {
              "description": "`true` lets us solve a captcha that blocks the browser (+10, only when one is solved). Off by default, so the price stays fixed.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "wait_for",
            "in": "query",
            "required": false,
            "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`.",
            "schema": {
              "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`.",
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "wait",
            "in": "query",
            "required": false,
            "description": "Milliseconds to let the page settle after it loads, up to 10000.",
            "schema": {
              "description": "Milliseconds to let the page settle after it loads, up to 10000.",
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            }
          },
          {
            "name": "max_credits",
            "in": "query",
            "required": false,
            "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
            "schema": {
              "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The page as a real Chrome browser shows it, after its JavaScript runs. Gets past JavaScript challenges. 1 credit.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/unblock": {
      "get": {
        "operationId": "web_unblock",
        "tags": [
          "Web"
        ],
        "summary": "Unblock a page (separate IPs)",
        "description": "Pages from sites that block our usual IPs (DataDome and the like), fetched by a browser on separate IPs. 4 credits.\n\nPass a `url`. A browser on separate IPs visits the page and returns the HTML the site sent, before JavaScript runs. Use it for sites that block our usual IPs, DataDome above all.\n\nIt can't pick a country, and it doesn't report where redirects ended, so `url` in the answer is the one you asked for. For pages built with JavaScript, use `render`. Usually 15–35 seconds.\n\n**Price.** Always 4 credits, and only when the page comes back. If the site blocks this step or can't be reached, the call fails with 502 `upstream_error` and costs nothing. Then `/v1/web/scrape` (Auto) can try the other steps for you, or `/v1/web/custom` the ones you list.\n\nFor AI models, use `format=markdown`, and add `main=true` to keep only the page's own content. Pages over 2 MB are cut off (`truncated: true`). The [web scraping guide](/docs/web-scraping) explains each step.\n\nCost: 4 credits.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/unblock"
        },
        "x-credits": 4,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Pages from sites that block our usual IPs (DataDome and the like), fetched by a browser on separate IPs. 4 credits.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/residential": {
      "get": {
        "operationId": "web_residential",
        "tags": [
          "Web"
        ],
        "summary": "Fetch a page from a residential IP",
        "description": "A page from a residential IP in the country you pick, without running JavaScript. 5 credits.\n\nPass a `url`, and a `country` if you want one other than the US. We request the page the way Chrome would, through a residential IP (the kind a home internet connection uses) in that country, without running JavaScript. Use it for sites that block our other IPs, or that show each country its own page. Usually 1–5 seconds.\n\n**Price.** Always 5 credits, and only when the page comes back. If the site blocks this step or can't be reached, the call fails with 502 `upstream_error` and costs nothing. Then `/v1/web/scrape` (Auto) can try the other steps for you, or `/v1/web/custom` the ones you list.\n\nFor AI models, use `format=markdown`, and add `main=true` to keep only the page's own content. Pages over 2 MB are cut off (`truncated: true`). The [web scraping guide](/docs/web-scraping) explains each step.\n\nCost: 5 credits.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/residential"
        },
        "x-credits": 5,
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "The country of the residential IP, as a two-letter code like `us`, `gb` or `de` (default `us`).",
            "schema": {
              "description": "The country of the residential IP, as a two-letter code like `us`, `gb` or `de` (default `us`).",
              "type": "string",
              "pattern": "^[a-zA-Z]{2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page from a residential IP in the country you pick, without running JavaScript. 5 credits.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/render-residential": {
      "get": {
        "operationId": "web_render_residential",
        "tags": [
          "Web"
        ],
        "summary": "Render a page from a residential IP",
        "description": "The page as a real Chrome browser on a residential IP shows it, for sites that block every other step. 14 credits.\n\nPass a `url`, and a `country` if you want one other than the US. A real Chrome browser loads the page through a residential IP there, runs its JavaScript and returns it as you'd see it. This is the strongest step, for sites that block every other one.\n\nSet `captcha=true` to also have DataDome's slider, Turnstile and reCAPTCHA solved. Usually 5–20 seconds, or up to 60 when a captcha is solved.\n\n**Price.** Always 14 credits (+10 if you set `captcha=true` and a captcha is solved), and only when the page comes back. If the site blocks this step or can't be reached, the call fails with 502 `upstream_error` and costs nothing. Then `/v1/web/scrape` (Auto) can try the other steps for you, or `/v1/web/custom` the ones you list.\n\nFor AI models, use `format=markdown`, and add `main=true` to keep only the page's own content. Pages over 2 MB are cut off (`truncated: true`). The [web scraping guide](/docs/web-scraping) explains each step.\n\nCost: 14 credits; 24 if a captcha is solved.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/render-residential"
        },
        "x-credits": 14,
        "x-extra-credits": {
          "captcha": 10
        },
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "The country of the residential IP, as a two-letter code like `us`, `gb` or `de` (default `us`).",
            "schema": {
              "description": "The country of the residential IP, as a two-letter code like `us`, `gb` or `de` (default `us`).",
              "type": "string",
              "pattern": "^[a-zA-Z]{2}$"
            }
          },
          {
            "name": "captcha",
            "in": "query",
            "required": false,
            "description": "`true` lets us solve a captcha that blocks the browser (+10, only when one is solved). Off by default, so the price stays fixed.",
            "schema": {
              "description": "`true` lets us solve a captcha that blocks the browser (+10, only when one is solved). Off by default, so the price stays fixed.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "wait_for",
            "in": "query",
            "required": false,
            "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`.",
            "schema": {
              "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`.",
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "wait",
            "in": "query",
            "required": false,
            "description": "Milliseconds to let the page settle after it loads, up to 10000.",
            "schema": {
              "description": "Milliseconds to let the page settle after it loads, up to 10000.",
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            }
          },
          {
            "name": "max_credits",
            "in": "query",
            "required": false,
            "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
            "schema": {
              "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The page as a real Chrome browser on a residential IP shows it, for sites that block every other step. 14 credits.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/web/custom": {
      "get": {
        "operationId": "web_custom",
        "tags": [
          "Web"
        ],
        "summary": "Scrape a page with your own steps",
        "description": "A page from the steps you choose, tried in your order. You pay only for the one that got the page.\n\nPass a `url` and `steps`, the steps to try in order, comma-separated. Use it when you know what a site needs. We stop at the first step that gets the page, and you pay for that one.\n\nEach step costs what its own endpoint does: `fetch` (1), `render` (1), `unblock` (4), `residential` (5), `render-residential` (14). For example, `steps=fetch,unblock` never costs more than 4 credits and never runs JavaScript. `steps=render,render-residential` always returns the page after its JavaScript ran.\n\nThe most you can pay is the priciest step you listed, plus 10 if you set `captcha=true` and a captcha is solved. We skip a later step when an earlier one already shows it can't get past the site's wall. `billing` in the answer says what the call cost.\n\n`country` applies to the residential steps; the others fetch from the US. `wait_for` and `wait` apply to the steps that render. If every step is blocked, the call fails with 502 `upstream_error` and costs nothing. The [web scraping guide](/docs/web-scraping) explains each step.\n\nCost: 1 credit; +3 if a browser on separate IPs gets it, +4 if it needs a residential IP, +13 if a browser renders it on a residential IP, +10 if a captcha is solved.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/web/custom"
        },
        "x-credits": 1,
        "x-extra-credits": {
          "unblock": 3,
          "premium": 4,
          "premium_render": 13,
          "captcha": 10
        },
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443).",
            "schema": {
              "type": "string",
              "pattern": "^https?:\\/\\/\\S+$",
              "description": "The page to fetch, as a full URL starting with `http://` or `https://`. It must be a public site on the standard ports (80 or 443)."
            },
            "example": "https://books.toscrape.com/"
          },
          {
            "name": "steps",
            "in": "query",
            "required": true,
            "description": "The steps to try, in order, comma-separated, e.g. `fetch,render`. Any of: `fetch`, `render`, `unblock`, `residential`, `render-residential`.",
            "schema": {
              "description": "The steps to try, in order, comma-separated, e.g. `fetch,render`. Any of: `fetch`, `render`, `unblock`, `residential`, `render-residential`.",
              "type": "string",
              "pattern": "^(fetch|render|unblock|residential|render-residential)(,(fetch|render|unblock|residential|render-residential))*$"
            },
            "example": "fetch,render"
          },
          {
            "name": "format",
            "in": "query",
            "required": false,
            "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
            "schema": {
              "description": "How `content` comes back: `html`, `markdown` (best for AI models) or plain `text`. JSON, XML and plain-text pages come back unchanged.",
              "default": "html",
              "type": "string",
              "enum": [
                "html",
                "markdown",
                "text"
              ]
            },
            "example": "markdown"
          },
          {
            "name": "main",
            "in": "query",
            "required": false,
            "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
            "schema": {
              "description": "`true` keeps only the page's own content: its `<h1>` and its `<main>` element (or its articles if it has no `<main>`, else the whole page). Navigation, sidebars, headers, footers, hidden parts, skip links and cookie banners are left out. Works with `format=markdown` or `text`; `format=html` ignores it.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "The country of the residential IP, as a two-letter code like `us`, `gb` or `de` (default `us`).",
            "schema": {
              "description": "The country of the residential IP, as a two-letter code like `us`, `gb` or `de` (default `us`).",
              "type": "string",
              "pattern": "^[a-zA-Z]{2}$"
            }
          },
          {
            "name": "captcha",
            "in": "query",
            "required": false,
            "description": "`true` lets us solve a captcha that blocks the browser (+10, only when one is solved). Off by default, so the price stays fixed.",
            "schema": {
              "description": "`true` lets us solve a captcha that blocks the browser (+10, only when one is solved). Off by default, so the price stays fixed.",
              "default": "false",
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "wait_for",
            "in": "query",
            "required": false,
            "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`.",
            "schema": {
              "description": "A CSS selector to wait for before returning, like `.price` or `#reviews`.",
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "wait",
            "in": "query",
            "required": false,
            "description": "Milliseconds to let the page settle after it loads, up to 10000.",
            "schema": {
              "description": "Milliseconds to let the page settle after it loads, up to 10000.",
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            }
          },
          {
            "name": "max_credits",
            "in": "query",
            "required": false,
            "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
            "schema": {
              "description": "The most this call may cost, in credits. A paid step that would go past it doesn't run; a call that can't be done within it fails with 402 `over_max_credits`, free.",
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page from the steps you choose, tried in your order. You pay only for the one that got the page.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "status": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991,
                      "description": "The HTTP status the site gave the page: 200, or its own 404, 410 and so on."
                    },
                    "url": {
                      "type": "string",
                      "description": "The page's URL after any redirects. When `via` is `unblocker`, it's the URL you asked for, since that step doesn't report redirects."
                    },
                    "title": {
                      "description": "The page's title, from its `<title>`; null when it has none or isn't HTML.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content_type": {
                      "description": "The page's Content-Type, like `text/html; charset=utf-8`; null if the site sent none.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "content": {
                      "description": "The page in the `format` you asked for: HTML, markdown or plain text. Null for binary files such as images, PDFs and archives.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "truncated": {
                      "type": "boolean",
                      "description": "The page was over 2 MB, so it was cut off there."
                    },
                    "via": {
                      "type": "string",
                      "enum": [
                        "direct",
                        "static",
                        "browser",
                        "unblocker",
                        "residential",
                        "browser_residential"
                      ],
                      "description": "The step that got the page: `direct` or `static` (plain requests), `browser` (our browser), `unblocker` (a browser on separate IPs), `residential` (a residential IP) or `browser_residential` (our browser on a residential IP)."
                    },
                    "captcha": {
                      "description": "The captcha solved to get the page (`turnstile`, `datadome` or `recaptcha`), which is charged. Null if none was solved.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "attempts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "via": {
                            "type": "string",
                            "enum": [
                              "direct",
                              "static",
                              "browser",
                              "unblocker",
                              "residential",
                              "browser_residential"
                            ],
                            "description": "The step tried."
                          },
                          "ms": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991,
                            "description": "How long it took, in milliseconds."
                          },
                          "status": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": -9007199254740991,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The HTTP status it got; null if no answer came back."
                          },
                          "wall": {
                            "description": "What blocked it, like `cloudflare challenge` or `datadome block`; null if nothing did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "error": {
                            "description": "Why it failed when no answer came back; null if one did.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "via",
                          "ms",
                          "status",
                          "wall",
                          "error"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Every step tried, in order. The last one got the page."
                    },
                    "billing": {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "auto",
                            "fixed",
                            "custom"
                          ],
                          "description": "`fixed`: this endpoint's set price. `auto` and `custom`: the price of the step that got the page."
                        },
                        "credits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991,
                          "description": "What this call cost, the sum of `breakdown`."
                        },
                        "breakdown": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "maximum": 9007199254740991
                          },
                          "description": "Credits by what they paid for: `base`, plus on Auto or Custom `unblock` (a browser on separate IPs), `premium` (a residential IP) or `premium_render` (a browser on a residential IP), and `captcha` when one was solved."
                        },
                        "note": {
                          "description": "On Auto and Custom, why the price varies; null on fixed-price endpoints.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "mode",
                        "credits",
                        "breakdown",
                        "note"
                      ],
                      "additionalProperties": false,
                      "description": "What this call cost and why."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "status",
                    "url",
                    "title",
                    "content_type",
                    "content",
                    "truncated",
                    "via",
                    "captcha",
                    "attempts",
                    "billing"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/v1/account/credit-balance": {
      "get": {
        "operationId": "account_credit_balance",
        "tags": [
          "Account"
        ],
        "summary": "Credit balance",
        "description": "Your credit balance and daily top-up. Free.\n\nUse it to check your balance before a batch of calls. It's free, and every other response also carries `credits_remaining`.\n\nOnce a day (UTC), if your balance is below 20 credits, your first call tops it up to 20. With a playground token instead of a key, `credits_remaining` is the free tries left today.\n\nCost: free.",
        "externalDocs": {
          "url": "https://lurkapi.com/docs/account/credit-balance"
        },
        "x-credits": 0,
        "parameters": [],
        "responses": {
          "200": {
            "description": "Your credit balance and daily top-up. Free.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "const": true,
                      "description": "Always true here; errors have `success: false`."
                    },
                    "credits_remaining": {
                      "type": "number",
                      "description": "Your balance after this call. On anonymous playground calls: free tries left today."
                    },
                    "credits_charged": {
                      "type": "number",
                      "description": "Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1)."
                    },
                    "daily_top_up": {
                      "type": "number",
                      "description": "Once a day (UTC), a balance below this is raised to it on your first call."
                    },
                    "next_top_up_at": {
                      "type": "string",
                      "description": "When the next daily top-up can apply: the coming 00:00 UTC, ISO 8601."
                    }
                  },
                  "required": [
                    "success",
                    "credits_remaining",
                    "credits_charged",
                    "daily_top_up",
                    "next_top_up_at"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "default": {
            "description": "Error. Not charged, except the endpoint's own 4xx answers such as not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "const": false
          },
          "error": {
            "type": "string",
            "description": "What went wrong, in plain words."
          },
          "code": {
            "type": "string",
            "enum": [
              "invalid_params",
              "missing_api_key",
              "invalid_api_key",
              "invalid_token",
              "insufficient_credits",
              "over_max_credits",
              "account_suspended",
              "not_public",
              "not_found",
              "transcript_unavailable",
              "method_not_allowed",
              "rate_limited",
              "signup_required",
              "upstream_error",
              "upstream_busy",
              "upstream_timeout",
              "internal_error"
            ],
            "description": "Stable machine-readable code."
          },
          "docs": {
            "type": "string",
            "description": "Page that explains how to fix it."
          },
          "issues": {
            "description": "One entry per invalid parameter (invalid_params only).",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              },
              "required": [
                "path",
                "message"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "success",
          "error",
          "code",
          "docs"
        ],
        "additionalProperties": false
      },
      "RedditComment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Comment id, e.g. `pcrhmoe`."
          },
          "name": {
            "type": "string",
            "description": "Fullname, `t1_` + id."
          },
          "author": {
            "description": "Username, without u/; null if unknown.",
            "type": [
              "string",
              "null"
            ]
          },
          "author_fullname": {
            "description": "Author's account fullname, `t2_` + id.",
            "type": [
              "string",
              "null"
            ]
          },
          "body": {
            "type": "string",
            "description": "Comment text, plain; an image or GIF becomes its URL. Empty for deleted and collapsed comments."
          },
          "body_html": {
            "description": "Comment text as HTML; null for deleted and collapsed comments.",
            "type": [
              "string",
              "null"
            ]
          },
          "score": {
            "type": "number",
            "description": "Upvotes minus downvotes."
          },
          "ups": {
            "type": "number",
            "description": "Same as score."
          },
          "created": {
            "type": "number",
            "description": "Posted at, Unix seconds."
          },
          "created_utc": {
            "type": "number",
            "description": "Posted at, Unix seconds."
          },
          "created_at_iso": {
            "type": "string",
            "description": "Posted at, ISO 8601."
          },
          "depth": {
            "type": "number",
            "description": "0 for top-level comments, 1 for their replies, and so on."
          },
          "parent_id": {
            "description": "`t3_…` for top-level comments, else the parent comment's `t1_…`.",
            "type": [
              "string",
              "null"
            ]
          },
          "link_id": {
            "description": "The post's fullname.",
            "type": [
              "string",
              "null"
            ]
          },
          "permalink": {
            "type": "string",
            "description": "Path to this comment on reddit.com."
          },
          "url": {
            "type": "string",
            "description": "This comment on reddit.com."
          },
          "subreddit": {
            "type": "string",
            "description": "Subreddit name without r/."
          },
          "subreddit_id": {
            "description": "Subreddit fullname, `t5_` + id.",
            "type": [
              "string",
              "null"
            ]
          },
          "subreddit_name_prefixed": {
            "type": "string",
            "description": "Subreddit name with the r/ prefix, e.g. `r/marketing`."
          },
          "collapsed": {
            "type": "boolean",
            "description": "Collapsed by default on Reddit (low score, deleted or moderated). reddit.com loads its text only when expanded, so `body` is empty."
          },
          "is_submitter": {
            "type": "boolean",
            "description": "Written by the post's author."
          },
          "replies": {
            "type": "object",
            "properties": {
              "items": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RedditComment"
                },
                "description": "Direct replies, each with its own replies."
              },
              "more": {
                "type": "object",
                "properties": {
                  "has_more": {
                    "type": "boolean",
                    "description": "Whether there are more comments to load here."
                  },
                  "next_cursor": {
                    "description": "Pass as `cursor` (with the same url) to load them; null when has_more is false.",
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "has_more",
                  "next_cursor"
                ],
                "additionalProperties": false,
                "description": "More comments that weren't loaded yet."
              }
            },
            "required": [
              "items",
              "more"
            ],
            "additionalProperties": false,
            "description": "Replies to this comment."
          }
        },
        "required": [
          "id",
          "name",
          "author",
          "author_fullname",
          "body",
          "body_html",
          "score",
          "ups",
          "created",
          "created_utc",
          "created_at_iso",
          "depth",
          "parent_id",
          "link_id",
          "permalink",
          "url",
          "subreddit",
          "subreddit_id",
          "subreddit_name_prefixed",
          "collapsed",
          "is_submitter",
          "replies"
        ],
        "additionalProperties": false
      },
      "BlueskyReply": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "The post's `at://` URI, its permanent id."
          },
          "cid": {
            "type": "string",
            "description": "Content hash of this version of the post."
          },
          "url": {
            "type": "string",
            "description": "The post on bsky.app."
          },
          "text": {
            "type": "string",
            "description": "Post text, with links the app shortened (`example.com/long-pa...`) written out in full. Empty for media-only posts."
          },
          "createdAt": {
            "type": "string",
            "description": "When it was posted, ISO 8601."
          },
          "author": {
            "type": "object",
            "properties": {
              "did": {
                "type": "string",
                "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
              },
              "handle": {
                "type": "string",
                "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
              },
              "displayName": {
                "description": "Display name; null if not set.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "avatar": {
                "description": "Avatar image URL; null if none.",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "did",
              "handle",
              "displayName",
              "avatar"
            ],
            "additionalProperties": false,
            "description": "Who posted it."
          },
          "replyCount": {
            "type": "number",
            "description": "Replies."
          },
          "repostCount": {
            "type": "number",
            "description": "Reposts."
          },
          "likeCount": {
            "type": "number",
            "description": "Likes."
          },
          "quoteCount": {
            "type": "number",
            "description": "Quote posts."
          },
          "bookmarkCount": {
            "type": "number",
            "description": "Times saved to bookmarks."
          },
          "langs": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Languages the author tagged, e.g. `en`."
          },
          "images": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "thumbnail": {
                  "type": "string",
                  "description": "Small image URL."
                },
                "fullsize": {
                  "type": "string",
                  "description": "Full-size image URL."
                },
                "alt": {
                  "type": "string",
                  "description": "Alt text; empty if none."
                }
              },
              "required": [
                "thumbnail",
                "fullsize",
                "alt"
              ],
              "additionalProperties": false
            },
            "description": "Attached images, in order. Empty if none."
          },
          "video": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "playlist": {
                    "type": "string",
                    "description": "HLS playlist (.m3u8) URL."
                  },
                  "thumbnail": {
                    "description": "Poster image URL; null if none.",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "alt": {
                    "description": "Alt text; null if none.",
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "playlist",
                  "thumbnail",
                  "alt"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "description": "Attached video; null if none."
          },
          "external": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "uri": {
                    "type": "string",
                    "description": "The linked page."
                  },
                  "title": {
                    "type": "string",
                    "description": "Link card title."
                  },
                  "description": {
                    "type": "string",
                    "description": "Link card description."
                  },
                  "thumbnail": {
                    "description": "Link card image URL; null if none.",
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "uri",
                  "title",
                  "description",
                  "thumbnail"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "description": "Link card; null if none."
          },
          "quote": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "uri": {
                    "type": "string",
                    "description": "The quoted post's `at://` URI. Pass it as `url` to the post endpoint."
                  },
                  "url": {
                    "type": "string",
                    "description": "The quoted post on bsky.app."
                  },
                  "text": {
                    "description": "Its text; null when it was deleted or its author blocks viewers.",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "createdAt": {
                    "description": "When it was posted, ISO 8601; null when unavailable.",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "author": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "did": {
                            "type": "string",
                            "description": "The account's permanent id, e.g. `did:plc:z72i7hdynmk6r22z27h6tvur`."
                          },
                          "handle": {
                            "type": "string",
                            "description": "Handle, e.g. `bsky.app`. It can change; the DID doesn't."
                          },
                          "displayName": {
                            "description": "Display name; null if not set.",
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "avatar": {
                            "description": "Avatar image URL; null if none.",
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "required": [
                          "did",
                          "handle",
                          "displayName",
                          "avatar"
                        ],
                        "additionalProperties": false,
                        "description": "Who posted it."
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Who posted it; null when unavailable."
                  }
                },
                "required": [
                  "uri",
                  "url",
                  "text",
                  "createdAt",
                  "author"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "description": "The post this one quotes; null if none or hidden from logged-out visitors. Embedded lists, feeds and starter packs aren't returned."
          },
          "links": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Full URLs of the links in the text."
          },
          "mentions": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Accounts mentioned in the text: the handle as written, without @, or the DID when the mention isn't written as @handle."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Hashtags in the text, without #."
          },
          "replyTo": {
            "description": "`at://` URI of the post this replies to; null for top-level posts.",
            "type": [
              "string",
              "null"
            ]
          },
          "replies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BlueskyReply"
            },
            "description": "Replies to this reply."
          }
        },
        "required": [
          "uri",
          "cid",
          "url",
          "text",
          "createdAt",
          "author",
          "replyCount",
          "repostCount",
          "likeCount",
          "quoteCount",
          "bookmarkCount",
          "langs",
          "images",
          "video",
          "external",
          "quote",
          "links",
          "mentions",
          "tags",
          "replyTo",
          "replies"
        ],
        "additionalProperties": false
      }
    }
  }
}