{"openapi":"3.1.0","info":{"title":"ScrapeCrate API","version":"1.0.0"},"servers":[{"url":"https://api.scrapecrate.com"}],"security":[{"ApiKey":[]}],"paths":{"/v1/youtube/transcripts/{video_id}":{"get":{"operationId":"youtube_transcript","tags":["YouTube"],"summary":"Get a transcript","description":"The transcript of a video as timed segments and plain text. Without `lang` you get the video's default caption track.\n\n**Price:** 1 credit per call.","parameters":[{"name":"video_id","in":"path","required":true,"description":"11-character video ID","schema":{"type":"string","minLength":11,"maxLength":11,"pattern":"^[A-Za-z0-9_-]{11}$"},"example":"dQw4w9WgXcQ"},{"name":"lang","in":"query","required":false,"description":"Language code (e.g. `en`, `it`, `pt-BR`); auto-translated when the video doesn't have it","schema":{"type":"string","minLength":2,"maxLength":10},"example":"en"},{"name":"format","in":"query","required":false,"description":"`json` (segments + text), `text` or `srt`","schema":{"type":"string","enum":["json","text","srt"],"default":"json"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"video_id":"dQw4w9WgXcQ","language":"en","is_generated":false,"text":"We're no strangers to love. You know the rules and so do I.","segments":[{"text":"We're no strangers to love","start":18.6,"duration":3.2},{"text":"You know the rules and so do I","start":22.4,"duration":4.1}]},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/transcripts/{video_id}/languages":{"get":{"operationId":"youtube_transcript_languages","tags":["YouTube"],"summary":"List transcript languages","description":"The caption tracks available for a video, manual and auto-generated.\n\n**Price:** 1 credit per call.","parameters":[{"name":"video_id","in":"path","required":true,"description":"11-character video ID","schema":{"type":"string","minLength":11,"maxLength":11,"pattern":"^[A-Za-z0-9_-]{11}$"},"example":"dQw4w9WgXcQ"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"video_id":"dQw4w9WgXcQ","languages":[{"language_code":"en","language":"English","is_generated":false,"is_translatable":true},{"language_code":"it","language":"Italian","is_generated":true,"is_translatable":true}]},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/videos/{video_id}":{"get":{"operationId":"youtube_video","tags":["YouTube"],"summary":"Get video metadata","description":"Title, description, channel, duration, views, likes, comment count, tags and categories.\n\n**Price:** 1 credit per call.","parameters":[{"name":"video_id","in":"path","required":true,"description":"11-character video ID","schema":{"type":"string","minLength":11,"maxLength":11,"pattern":"^[A-Za-z0-9_-]{11}$"},"example":"dQw4w9WgXcQ"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"video_id":"dQw4w9WgXcQ","title":"Never Gonna Give You Up","description":"The official video.","channel_id":"UCuAXFkgsw1L7xaCfnd5JJOw","channel_name":"Rick Astley","duration":213,"view_count":1600000000,"like_count":18000000,"comment_count":2400000,"upload_date":"2009-10-25","thumbnail_url":"https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg","tags":["rick astley","never gonna give you up"],"categories":["Music"]},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/videos/{video_id}/chapters":{"get":{"operationId":"youtube_video_chapters","tags":["YouTube"],"summary":"Get video chapters","description":"The chapters of a video with start and end times in seconds.\n\n**Price:** 1 credit per call.","parameters":[{"name":"video_id","in":"path","required":true,"description":"11-character video ID","schema":{"type":"string","minLength":11,"maxLength":11,"pattern":"^[A-Za-z0-9_-]{11}$"},"example":"dQw4w9WgXcQ"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"video_id":"dQw4w9WgXcQ","has_chapters":true,"chapters":[{"title":"Intro","start_time":0,"end_time":18},{"title":"Verse 1","start_time":18,"end_time":43}]},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/videos/{video_id}/comments":{"get":{"operationId":"youtube_video_comments","tags":["YouTube"],"summary":"List video comments","description":"Top-level comments of a video with author, likes, replies count, date and pinned flag.\n\n**Price:** 1 credit per 100 items returned (min 1); one call returns one page of at most 100; the next page is a new call.","parameters":[{"name":"video_id","in":"path","required":true,"description":"11-character video ID","schema":{"type":"string","minLength":11,"maxLength":11,"pattern":"^[A-Za-z0-9_-]{11}$"},"example":"dQw4w9WgXcQ"},{"name":"sort","in":"query","required":false,"description":"Top comments or newest first","schema":{"type":"string","enum":["top","new"],"default":"top"}},{"name":"limit","in":"query","required":false,"description":"Comments per page (max 100)","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"comment_id":"UgzX1a2b3c4d5e6f7g8h","text":"Still a classic.","author":"@musicfan","like_count":1520,"reply_count":12,"published_at":"2024-03-01T10:00:00Z","is_pinned":false}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/channels/{channel_id}":{"get":{"operationId":"youtube_channel","tags":["YouTube"],"summary":"Get a channel","description":"Channel details by channel ID (`UC...`) or @handle.\n\n**Price:** 1 credit per call.","parameters":[{"name":"channel_id","in":"path","required":true,"description":"Channel ID (`UC...`) or @handle","schema":{"type":"string","minLength":2,"maxLength":100},"example":"@RickAstleyYT"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"channel_id":"UCuAXFkgsw1L7xaCfnd5JJOw","name":"Rick Astley","description":"The official channel.","subscriber_count":4100000,"video_count":320,"thumbnail_url":"https://yt3.ggpht.com/example.jpg","channel_url":"https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/channels/{channel_id}/videos":{"get":{"operationId":"youtube_channel_videos","tags":["YouTube"],"summary":"List channel videos","description":"The videos of a channel, newest first, page by page.\n\n**Price:** 1 credit per call; one call returns one page of at most 100; the next page is a new call.","parameters":[{"name":"channel_id","in":"path","required":true,"description":"Channel ID (`UC...`) or @handle","schema":{"type":"string","minLength":2,"maxLength":100},"example":"@RickAstleyYT"},{"name":"include_shorts","in":"query","required":false,"description":"Include Shorts","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Videos per page (max 100)","schema":{"type":"integer","minimum":1,"maximum":100,"default":30}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"video_id":"dQw4w9WgXcQ","title":"Never Gonna Give You Up","duration":213,"view_count":1600000000,"published_at":"2009-10-25","thumbnail_url":"https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg"}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/youtube/search":{"get":{"operationId":"youtube_search","tags":["YouTube"],"summary":"Search videos","description":"Search by keyword and get videos with channel, duration, views and upload date.\n\n**Price:** 1 credit per call; one call returns one page of at most 50; the next page is a new call.","parameters":[{"name":"q","in":"query","required":true,"description":"Search query","schema":{"type":"string","minLength":1,"maxLength":500},"example":"lofi hip hop"},{"name":"limit","in":"query","required":false,"description":"Results (max 50)","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"video_id":"jfKfPfyJRdk","title":"lofi hip hop radio","channel_name":"Lofi Girl","channel_id":"UCSJ4gkVC6NrvII8umztf0Ow","duration":0,"view_count":900000000,"upload_date":"2022-07-12","thumbnail_url":"https://i.ytimg.com/vi/jfKfPfyJRdk/hqdefault.jpg"}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":1,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/maps/places/search":{"get":{"operationId":"maps_places_search","tags":["Google Maps"],"summary":"Search places","description":"Places matching a query, optionally around a point, up to 20 per call.\n\n**Price:** 3 credits per call; one call returns one page of at most 20; the next page is a new call.","parameters":[{"name":"q","in":"query","required":true,"description":"What to search, e.g. `dentist in Berlin`","schema":{"type":"string","minLength":1,"maxLength":300},"example":"pizzeria in Milan"},{"name":"language","in":"query","required":false,"description":"Result language (`en`, `it`, `pt-BR`...)","schema":{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$","default":"en"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code to bias results","schema":{"type":"string","pattern":"^[a-z]{2}$","default":"us"}},{"name":"lat","in":"query","required":false,"description":"Latitude of the search centre (with `lng`)","schema":{"type":"number","minimum":-90,"maximum":90}},{"name":"lng","in":"query","required":false,"description":"Longitude of the search centre (with `lat`)","schema":{"type":"number","minimum":-180,"maximum":180}},{"name":"radius_km","in":"query","required":false,"description":"Radius around `lat`/`lng` in km","schema":{"type":"number","minimum":0.1,"maximum":100}},{"name":"limit","in":"query","required":false,"description":"Places per page (max 20)","schema":{"type":"integer","minimum":1,"maximum":20,"default":20}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"ChIJ2eUgeAK6j4ARbn5u_wAGqWA","name":"Pizzeria Da Mario","primary_category":"Pizza restaurant","categories":["Pizza restaurant","Italian restaurant"],"address":{"formatted":"Via Roma 1, 20121 Milano MI, Italy","city":"Milano","country_code":"IT"},"location":{"lat":45.4642,"lng":9.19},"rating":4.6,"review_count":1284,"phone":"+39 02 1234567","website":"https://example.com","status":"operational"}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":3,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/maps/places/{place_id}":{"get":{"operationId":"maps_place","tags":["Google Maps"],"summary":"Get place details","description":"Full details of a place by place ID, CID or feature ID.\n\n**Price:** 3 credits per call.","parameters":[{"name":"place_id","in":"path","required":true,"description":"Place ID, CID or feature ID (use `/places/resolve` for URLs)","schema":{"type":"string","minLength":3,"maxLength":300},"example":"ChIJ2eUgeAK6j4ARbn5u_wAGqWA"},{"name":"language","in":"query","required":false,"description":"Result language","schema":{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$","default":"en"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code","schema":{"type":"string","pattern":"^[a-z]{2}$","default":"us"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"id":"ChIJ2eUgeAK6j4ARbn5u_wAGqWA","cid":"12345678901234567890","name":"Pizzeria Da Mario","primary_category":"Pizza restaurant","address":{"formatted":"Via Roma 1, 20121 Milano MI, Italy","street":"Via Roma 1","postal_code":"20121","city":"Milano","country_code":"IT"},"location":{"lat":45.4642,"lng":9.19},"rating":4.6,"review_count":1284,"phone":"+39 02 1234567","website":"https://example.com","timezone":"Europe/Rome","opening_hours":{"weekly":[{"day":"monday","open":"12:00","close":"23:00"}]},"attributes":{"Service options":["Dine-in","Takeaway"]},"photos":[{"url":"https://example.com/photo.jpg","width":1024,"height":768}]},"meta":{"request_id":"req_123","credits_used":3,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/maps/places/{place_id}/reviews":{"get":{"operationId":"maps_place_reviews","tags":["Google Maps"],"summary":"List place reviews","description":"Reviews of a place with rating, text, translation, date and owner response.\n\n**Price:** 3 credits per call; one call returns one page of at most 20; the next page is a new call.","parameters":[{"name":"place_id","in":"path","required":true,"description":"Place ID, CID or feature ID","schema":{"type":"string","minLength":3,"maxLength":300},"example":"ChIJ2eUgeAK6j4ARbn5u_wAGqWA"},{"name":"sort","in":"query","required":false,"description":"Review order","schema":{"type":"string","enum":["relevant","newest","highest","lowest"],"default":"relevant"}},{"name":"language","in":"query","required":false,"description":"Language of translations","schema":{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$","default":"en"}},{"name":"limit","in":"query","required":false,"description":"Reviews per page (max 20, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":20,"default":20}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"ChZDSUhNMG9nS0VJQ0FnSUNz","rating":5,"published_at":"2026-10-02T19:12:00Z","language":"it","text":"Pizza ottima, servizio veloce.","translated_text":"Great pizza, fast service.","author":{"id":"a_5f2c9e","review_count":31,"is_local_guide":true},"owner_response":{"text":"Grazie!","published_at":"2026-10-03T08:00:00Z"}}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":3,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/maps/places/resolve":{"get":{"operationId":"maps_places_resolve","tags":["Google Maps"],"summary":"Resolve a Maps URL or ID","description":"Turn any Google Maps URL, short link, CID or feature ID into the place IDs.\n\n**Price:** 3 credits per call.","parameters":[{"name":"input","in":"query","required":true,"description":"A Maps URL, short link, CID or feature ID","schema":{"type":"string","minLength":3,"maxLength":2000},"example":"https://maps.app.goo.gl/abc123"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"place_id":"ChIJ2eUgeAK6j4ARbn5u_wAGqWA","cid":"12345678901234567890","feature_id":"0x4786c6aec34636a1:0xab7f4e27101a2e13","google_maps_url":"https://www.google.com/maps?cid=12345678901234567890"},"meta":{"request_id":"req_123","credits_used":3,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/trustpilot/companies/search":{"get":{"operationId":"trustpilot_companies_search","tags":["Trustpilot"],"summary":"Search companies","description":"Companies matching a name or domain.\n\n**Price:** 8 credits per call; one call returns one page of at most 10; the next page is a new call.","parameters":[{"name":"query","in":"query","required":true,"description":"Company name or domain","schema":{"type":"string","minLength":1,"maxLength":200},"example":"booking.com"},{"name":"limit","in":"query","required":false,"description":"Companies per page (max 10, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":10,"default":10}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"46a8b9f9000064000500a87e","domain":"booking.com","name":"Booking.com","trust_score":3.9,"stars":4,"review_count":98000,"categories":[{"id":"travel_agency","name":"Travel Agency","is_primary":true}]}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":8,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/trustpilot/companies/{domain}":{"get":{"operationId":"trustpilot_company","tags":["Trustpilot"],"summary":"Get a company","description":"Company profile with trust score, star distribution, languages and reply behaviour.\n\n**Price:** 8 credits per call.","parameters":[{"name":"domain","in":"path","required":true,"description":"Company domain, e.g. `booking.com`","schema":{"type":"string","minLength":3,"maxLength":253},"example":"booking.com"},{"name":"include_similar","in":"query","required":false,"description":"Include similar companies","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"id":"46a8b9f9000064000500a87e","domain":"booking.com","name":"Booking.com","trust_score":3.9,"review_count":98000,"star_distribution":{"one":12000,"two":3000,"three":4000,"four":14000,"five":65000},"country":"NL","is_claimed":true,"reply_behavior":{"reply_rate":0.72,"average_days_to_reply":2.1}},"meta":{"request_id":"req_123","credits_used":8,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/trustpilot/companies/{domain}/reviews":{"get":{"operationId":"trustpilot_company_reviews","tags":["Trustpilot"],"summary":"List company reviews","description":"Public reviews of a company with filters. `meta.complete` is false when the source caps the reviews reachable for a filter combination.\n\n**Price:** 8 credits per call; one call returns one page of at most 20; the next page is a new call.","parameters":[{"name":"domain","in":"path","required":true,"description":"Company domain","schema":{"type":"string","minLength":3,"maxLength":253},"example":"booking.com"},{"name":"stars","in":"query","required":false,"description":"Comma-separated star ratings","schema":{"type":"string","pattern":"^[1-5](,[1-5])*$"},"example":"1,2"},{"name":"language","in":"query","required":false,"description":"`all` or an ISO 639-1 code","schema":{"type":"string","default":"all"}},{"name":"since","in":"query","required":false,"description":"Published on or after (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"description":"Published on or before (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"verified","in":"query","required":false,"description":"Only verified reviews","schema":{"type":"boolean","default":false}},{"name":"with_reply","in":"query","required":false,"description":"Only reviews with a company reply","schema":{"type":"boolean","default":false}},{"name":"search","in":"query","required":false,"description":"Full-text filter","schema":{"type":"string","maxLength":100}},{"name":"sort","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["recent","relevant"],"default":"recent"}},{"name":"limit","in":"query","required":false,"description":"Reviews per page (max 20, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":20,"default":20}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"6553a1f0e3b5c1a2b3c4d5e6","rating":5,"title":"Easy booking","text":"Found a great hotel in minutes.","language":"en","published_at":"2026-11-02T09:30:00Z","is_verified":true,"author":{"id":"u_8e1f0a","country":"GB","review_count":4},"reply":{"text":"Thank you!","published_at":"2026-11-03T10:00:00Z"}}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":8,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/trustpilot/categories":{"get":{"operationId":"trustpilot_categories","tags":["Trustpilot"],"summary":"List categories","description":"The category tree used to browse companies.\n\n**Price:** 8 credits per call.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":[{"id":"travel_agency","name":"Travel Agency","subcategories":[]}],"meta":{"request_id":"req_123","credits_used":8,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/trustpilot/categories/{category_id}/companies":{"get":{"operationId":"trustpilot_category_companies","tags":["Trustpilot"],"summary":"List companies in a category","description":"Companies of a category in a country, with optional trust score and city filters.\n\n**Price:** 8 credits per call; one call returns one page of at most 20; the next page is a new call.","parameters":[{"name":"category_id","in":"path","required":true,"description":"Category ID from `/categories`","schema":{"type":"string","minLength":2,"maxLength":100},"example":"travel_agency"},{"name":"country","in":"query","required":true,"description":"Two-letter country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"example":"IT"},{"name":"sort","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["relevant","reviews_count"],"default":"relevant"}},{"name":"min_trust_score","in":"query","required":false,"description":"Minimum trust score","schema":{"type":"string","enum":["3.0","4.0","4.5"]}},{"name":"location","in":"query","required":false,"description":"City, e.g. `Milano`","schema":{"type":"string","maxLength":100}},{"name":"limit","in":"query","required":false,"description":"Companies per page (max 20, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":20,"default":20}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"5f0a1b2c3d4e5f6a7b8c9d0e","domain":"example-travel.it","name":"Example Travel","trust_score":4.5,"review_count":2300}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":8,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ads/search":{"get":{"operationId":"ads_ads_search","tags":["Meta Ad Library"],"summary":"Search ads","description":"Ads matching a keyword or an advertiser page, with filters, up to 30 per call.\n\n**Price:** 5 credits per call; one call returns one page of at most 30; the next page is a new call.","parameters":[{"name":"q","in":"query","required":false,"description":"Keyword (required unless `page_id` is set)","schema":{"type":"string","maxLength":100},"example":"running shoes"},{"name":"page_id","in":"query","required":false,"description":"Only ads of this advertiser page","schema":{"type":"string","pattern":"^[0-9]{1,30}$"}},{"name":"country","in":"query","required":false,"description":"Two-letter country code or `ALL`","schema":{"type":"string","pattern":"^([A-Z]{2}|ALL)$","default":"ALL"}},{"name":"status","in":"query","required":false,"description":"Ad status","schema":{"type":"string","enum":["active","inactive","all"],"default":"active"}},{"name":"ad_type","in":"query","required":false,"description":"All ads or political/issue ads","schema":{"type":"string","enum":["all","political"],"default":"all"}},{"name":"media_type","in":"query","required":false,"description":"Creative type","schema":{"type":"string","enum":["all","image","video","meme","none"],"default":"all"}},{"name":"platforms","in":"query","required":false,"description":"Comma-separated: facebook, instagram, messenger, audience_network","schema":{"type":"string"}},{"name":"languages","in":"query","required":false,"description":"Comma-separated ISO 639-1 codes","schema":{"type":"string"}},{"name":"active_from","in":"query","required":false,"description":"Running on or after (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"active_to","in":"query","required":false,"description":"Running on or before (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"match","in":"query","required":false,"description":"Keyword match","schema":{"type":"string","enum":["any","exact"],"default":"any"}},{"name":"sort","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["relevance","impressions"],"default":"relevance"}},{"name":"limit","in":"query","required":false,"description":"Ads per page (max 30, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":30,"default":30}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"1234567890123456","url":"https://www.facebook.com/ads/library/?id=1234567890123456","page":{"id":"102030405060708","name":"Example Shoes"},"status":"active","started_at":"2026-10-15","platforms":["facebook","instagram"],"format":"image","body":"Run further with our new trainers.","title":"New collection","link_url":"https://example.com/shoes","cta":{"text":"Shop now","type":"SHOP_NOW"},"images":[{"type":"image","url":"https://example.com/creative.jpg"}]}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":5,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ads/{ad_id}":{"get":{"operationId":"ads_ad","tags":["Meta Ad Library"],"summary":"Get an ad","description":"One ad with creatives, payer and beneficiary, and EU/UK transparency data.\n\n**Price:** 5 credits per call.","parameters":[{"name":"ad_id","in":"path","required":true,"description":"Ad Library ID","schema":{"type":"string","pattern":"^[0-9]{5,30}$"},"example":"1234567890123456"},{"name":"country","in":"query","required":false,"description":"Country used to look the ad up","schema":{"type":"string","pattern":"^([A-Z]{2}|ALL)$","default":"ALL"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"id":"1234567890123456","page":{"id":"102030405060708","name":"Example Shoes"},"status":"active","started_at":"2026-10-15","payers":[{"payer":"Example Shoes Ltd","beneficiary":"Example Shoes Ltd"}],"transparency":{"eu":{"reach":120000,"age_min":18,"age_max":65}}},"meta":{"request_id":"req_123","credits_used":5,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ads/pages/search":{"get":{"operationId":"ads_pages_search","tags":["Meta Ad Library"],"summary":"Search advertisers","description":"Advertiser pages whose ads match a keyword.\n\n**Price:** 5 credits per call; one call returns one page of at most 10; the next page is a new call.","parameters":[{"name":"q","in":"query","required":true,"description":"Keyword","schema":{"type":"string","minLength":1,"maxLength":100},"example":"running shoes"},{"name":"country","in":"query","required":false,"description":"Two-letter country code or `ALL`","schema":{"type":"string","pattern":"^([A-Z]{2}|ALL)$","default":"ALL"}},{"name":"limit","in":"query","required":false,"description":"Pages (max 10, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":10,"default":10}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"102030405060708","name":"Example Shoes","category":"Shopping & retail","like_count":52000,"verified":true}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":5,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ads/pages/{page_id}":{"get":{"operationId":"ads_page","tags":["Meta Ad Library"],"summary":"Get an advertiser","description":"Advertiser page details with Instagram account and active ads estimate.\n\n**Price:** 5 credits per call.","parameters":[{"name":"page_id","in":"path","required":true,"description":"Advertiser page ID","schema":{"type":"string","pattern":"^[0-9]{1,30}$"},"example":"102030405060708"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}}},"example":{"data":{"id":"102030405060708","name":"Example Shoes","category":"Shopping & retail","like_count":52000,"instagram":{"username":"exampleshoes","followers":81000,"verified":false},"active_ads_estimate":42},"meta":{"request_id":"req_123","credits_used":5,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ads/pages/{page_id}/ads":{"get":{"operationId":"ads_page_ads","tags":["Meta Ad Library"],"summary":"List an advertiser's ads","description":"The ads of one advertiser page, with the same filters as search.\n\n**Price:** 5 credits per call; one call returns one page of at most 30; the next page is a new call.","parameters":[{"name":"page_id","in":"path","required":true,"description":"Advertiser page ID","schema":{"type":"string","pattern":"^[0-9]{1,30}$"},"example":"102030405060708"},{"name":"country","in":"query","required":false,"description":"Two-letter country code or `ALL`","schema":{"type":"string","pattern":"^([A-Z]{2}|ALL)$","default":"ALL"}},{"name":"status","in":"query","required":false,"description":"Ad status","schema":{"type":"string","enum":["active","inactive","all"],"default":"active"}},{"name":"media_type","in":"query","required":false,"description":"Creative type","schema":{"type":"string","enum":["all","image","video","meme","none"],"default":"all"}},{"name":"limit","in":"query","required":false,"description":"Ads per page (max 30, one page of the source)","schema":{"type":"integer","minimum":1,"maximum":30,"default":30}},{"name":"cursor","in":"query","required":false,"description":"`pagination.next_cursor` of the previous page","schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"example":{"data":[{"id":"1234567890123456","page":{"id":"102030405060708","name":"Example Shoes"},"status":"active","started_at":"2026-10-15","platforms":["facebook","instagram"],"format":"image","body":"Run further with our new trainers."}],"pagination":{"next_cursor":null,"has_more":false},"meta":{"request_id":"req_123","credits_used":5,"credits_remaining":9999}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"Meta":{"type":"object","properties":{"request_id":{"type":"string"},"credits_used":{"type":"integer"},"credits_remaining":{"type":"integer"},"limit_reduced":{"type":"boolean"}}},"Pagination":{"type":"object","properties":{"next_cursor":{"type":["string","null"]},"has_more":{"type":"boolean"}}},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"},"details":{}}}}}}}}