{"openapi":"3.1.0","info":{"title":"Stophy API","version":"1","description":"Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400.\n\nResponses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent.\n\nx-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description sets a price scale. Then x-credits is the lowest price and x-credits-max the highest.\n\nWhen a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number.\n\nEndpoints whose security includes {} also work without an API key: 10 requests a minute and 50 a day per IP, and no paging."},"servers":[{"url":"https://api.stophy.dev"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer"}},"schemas":{"Error":{"type":"object","required":["success","error"],"properties":{"success":{"const":false},"error":{"type":"object","required":["code","message","retryable","requestId"],"properties":{"code":{"type":"string","enum":["cliSessionCompleted","cliSessionExists","cliSessionNotFound","forbidden","insufficientCredits","internalError","inviteClaimed","inviteDisabled","inviteExpired","inviteUsedUp","invalidCliSession","invalidCliVerifier","invalidRequest","notFound","rateLimited","sourceChanged","sourceRefused","sourceTimeout","sourceUnavailable","tooManyInFlight","unauthorized","unsupportedMediaType"]},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"requestId":{"type":"string"},"requiredCredits":{"type":"number"},"availableCredits":{"type":"number"},"billingUrl":{"type":"string","const":"https://stophy.dev/billing"}}}}},"EndpointCatalog":{"type":"object","required":["endpoints","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","required":["id","name","summary"],"properties":{"id":{"type":"string"},"name":{"type":"string","description":"The source's name, such as YouTube or Google Maps."},"summary":{"type":"string","description":"What you can get from this source."}}}},"endpoints":{"type":"array","items":{"type":"object","required":["id","title","summary","bestWhen","method","path","credits","keyless","cacheTtlSeconds","example"],"properties":{"id":{"type":"string"},"title":{"type":"string","description":"A short name for the endpoint within its source, such as Comment replies."},"summary":{"type":"string","description":"What this endpoint returns, in one line."},"bestWhen":{"type":["string","null"],"description":"When this endpoint beats a similar one, such as another source with the same kind of data. Null when there is no overlap worth calling out."},"method":{"const":"POST"},"path":{"type":"string"},"credits":{"type":"integer","description":"What one call costs, or the lowest it can cost when pricing is set."},"pricing":{"type":["string","null"],"description":"How the price changes with the answer. Null when every call costs the same."},"keyless":{"type":"boolean"},"cacheTtlSeconds":{"type":"integer"},"input":{"type":"object","description":"The endpoint's input as JSON Schema."},"example":{"type":["object","null"],"description":"A real input for this endpoint, or null when there is none."}}}}}}},"headers":{"RequestId":{"description":"The request id. Quote it when you report a problem.","schema":{"type":"string"}},"CreditsUsed":{"description":"Credits this call used.","schema":{"type":"integer"}},"RateLimitLimit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimitRemaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimitReset":{"description":"Unix time in seconds when the current window resets.","schema":{"type":"integer"}},"RetryAfter":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"Cache":{"description":"hit if this result came from the cache, miss if it was fetched live.","schema":{"type":"string"}},"CacheAge":{"description":"Seconds since the returned result was written to the cache.","schema":{"type":"integer"}}},"responses":{"Error":{"description":"The request failed. retryable says whether trying again can help.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/endpoints":{"get":{"operationId":"listEndpoints","summary":"List every endpoint with its cost and input schema.","security":[{}],"responses":{"200":{"description":"The endpoint catalog.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointCatalog"}}}}}}},"/v1/google/search":{"post":{"operationId":"googleSearch","summary":"Search Google and get results, the AI Overview, the knowledge panel and related questions","description":"Costs 1 credit per call. Pages with page. Works without an API key, within free limits.","security":[{},{"apiKey":[]}],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":400},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Two-letter language code like en or pt. Any case is accepted."},"includeDomains":{"maxItems":10,"type":"array","items":{"type":"string"}},"excludeDomains":{"maxItems":10,"type":"array","items":{"type":"string"}},"within":{"default":"all","type":"string","enum":["day","week","month","year","all"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":100}},"required":["query"],"additionalProperties":false},"example":{"query":"best project management software"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"aiOverview":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string","minLength":1},"sources":{"description":"Pages the overview cites.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string","minLength":1}},"required":["url"]}}},"required":["text"]},"knowledgeGraph":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","minLength":1},"type":{"type":"string"},"website":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"description":{"type":"string"},"descriptionSource":{"type":"string"},"descriptionUrl":{"type":"string","format":"uri"},"attributes":{"description":"Labelled facts, like Founded or Headquarters.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["title"]},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string","minLength":1},"description":{"description":"Text shown under the title.","type":"string"},"date":{"description":"Day shown on the result, when there is one.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"sitelinks":{"description":"Links listed under the result.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","minLength":1,"description":"Link text."},"url":{"type":"string","format":"uri","description":"Destination URL."}},"required":["title","url"]}},"position":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["url","title","position"]}},"peopleAlsoAsk":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"question":{"type":"string","minLength":1},"answer":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["question"]}},"relatedSearches":{"type":"array","items":{"type":"string"}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/google/news":{"post":{"operationId":"googleNews","summary":"Search Google News by keyword, date, site and country, or read headlines by topic","description":"Costs 1 credit per call. Pages with page. Works without an API key, within free limits.","security":[{},{"apiKey":[]}],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":400},"topic":{"description":"The top 10 headlines in one section instead of a search. Send query or topic, not both.","type":"string","enum":["world","nation","business","technology","entertainment","sports","science","health"]},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Two-letter language code like en or pt. Any case is accepted."},"includeDomains":{"maxItems":10,"type":"array","items":{"type":"string"}},"excludeDomains":{"maxItems":10,"type":"array","items":{"type":"string"}},"within":{"default":"all","type":"string","enum":["hour","day","week","month","year","all"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":20}},"additionalProperties":false},"example":{"query":"nvidia"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string","minLength":1},"source":{"description":"Publication that ran the article.","type":"string"},"description":{"description":"Text shown under the headline.","type":"string"},"publishedAt":{"description":"When the article was published.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"position":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["url","title","position"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/google/images":{"post":{"operationId":"googleImages","summary":"Search Google Images and get each full-size image with the page it comes from","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":400},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Two-letter language code like en or pt. Any case is accepted."}},"required":["query"],"additionalProperties":false},"example":{"query":"golden retriever puppy"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"imageUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"pageUrl":{"type":"string","format":"uri"},"source":{"type":"string"},"width":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"height":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["imageUrl","pageUrl","width","height","thumbnailUrl","position"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/google/aiMode":{"post":{"operationId":"googleAiMode","summary":"Ask Google AI Mode a question and get its answer with the sources it cites","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"The question to ask, worded the way a person would ask it."},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Two-letter language code like en or pt. Any case is accepted."}},"required":["prompt"],"additionalProperties":false},"example":{"prompt":"What is the best CRM for a small business?"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"prompt":{"type":"string"},"answer":{"type":"string","minLength":1},"sources":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string"}},"required":["url"]}}},"required":["answer","sources"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/google/shopping":{"post":{"operationId":"googleShopping","summary":"Compare product prices and sellers on Google Shopping by country","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":400},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Two-letter language code like en or pt. Any case is accepted."},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":20}},"required":["query"],"additionalProperties":false},"example":{"query":"running shoes"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","minLength":1},"price":{"type":"number","exclusiveMinimum":0,"description":"Current price in the country's currency."},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"originalPrice":{"description":"Higher price Google shows next to the current one, when there is one.","type":"number","exclusiveMinimum":0},"seller":{"description":"Store with the listed price.","type":"string"},"delivery":{"description":"Delivery terms, in the page language.","type":"string"},"returns":{"description":"Return terms, in the page language.","type":"string"},"rating":{"type":"number","minimum":0,"maximum":5},"reviews":{"description":"How many reviews the rating is based on.","type":"integer","minimum":0,"maximum":9007199254740991},"position":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["title","price","position"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/youtube/search":{"post":{"operationId":"youtubeSearch","summary":"Search YouTube videos, channels, playlists and shorts","description":"Costs 1 credit per call. Pages with cursor. Works without an API key, within free limits.","security":[{},{"apiKey":[]}],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":400},"type":{"default":"videos","type":"string","enum":["videos","all","channels","playlists","shorts"]},"within":{"default":"all","type":"string","enum":["hour","day","week","month","year","all"]},"sort":{"default":"relevance","type":"string","enum":["relevance","top"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["query"],"additionalProperties":false},"example":{"query":"rust tutorial"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"video"},"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"isShort":{"type":"boolean"},"isLive":{"type":"boolean"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["type","videoUrl","isShort","isLive"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"channel"},"channelId":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelName":{"type":"string"},"channelUsername":{"type":"string"},"description":{"type":"string"},"subscribers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"}},"required":["type","channelUrl"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"playlist"},"playlistId":{"type":"string"},"playlistUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"videos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"}},"required":["type","playlistUrl"]}]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/youtube/video":{"post":{"operationId":"youtubeVideo","summary":"Get a video's title, channel, views, likes and description","description":"Costs 1 credit per call. Works without an API key, within free limits.","security":[{},{"apiKey":[]}],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"type":"string"}},"required":["video"],"additionalProperties":false},"example":{"video":"dQw4w9WgXcQ"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"isShort":{"type":"boolean"},"isLive":{"type":"boolean"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"description":{"type":"string"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}},"required":["videoUrl","isShort","isLive","tags"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/transcript":{"post":{"operationId":"transcript","summary":"Get what a YouTube or other video says. 2 credits with captions, else 2 plus 1 per 10 s","description":"Costs 2 credits when the video has captions; otherwise 2 credits plus 1 credit for every 10 seconds of audio, up to 30 minutes. Works without an API key for YouTube videos, within free limits.","security":[{},{"apiKey":[]}],"x-credits":2,"x-credits-max":182,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"type":"string"},"language":{"type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."},"includeTimestamps":{"default":false,"type":"boolean"}},"required":["video"],"additionalProperties":false},"example":{"video":"dQw4w9WgXcQ"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"language":{"type":"string"},"isAutoGenerated":{"type":"boolean"},"durationSeconds":{"type":"number"},"transcribedSeconds":{"type":"number"},"text":{"type":"string"},"segments":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"startSeconds":{"type":"number"},"endSeconds":{"type":"number"},"text":{"type":"string"}},"required":["startSeconds","endSeconds"]}}},"required":["videoUrl","isAutoGenerated"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/youtube/comments":{"post":{"operationId":"youtubeComments","summary":"Get a video's comments, or the replies to one comment","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"type":"string"},"comment":{"description":"A comment's repliesCursor from an earlier response. Returns that comment's replies.","type":"string","minLength":1,"maxLength":12000},"sort":{"default":"top","type":"string","enum":["top","newest"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["video"],"additionalProperties":false},"example":{"video":"dQw4w9WgXcQ"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"commentId":{"type":"string"},"commentUrl":{"type":"string","format":"uri"},"text":{"type":"string"},"authorId":{"type":"string"},"authorName":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replies":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"isPinned":{"type":"boolean"},"isHearted":{"type":"boolean"},"isChannelOwner":{"type":"boolean"},"repliesCursor":{"type":"string"}},"required":["commentUrl","likes","replies","isPinned","isHearted","isChannelOwner"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/youtube/channel":{"post":{"operationId":"youtubeChannel","summary":"Get a channel's profile and a page of its videos, shorts, playlists or posts","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","minLength":2,"maxLength":200},"tab":{"default":"videos","type":"string","enum":["videos","shorts","live","playlists","posts"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["channel"],"additionalProperties":false},"example":{"channel":"@mkbhd"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"channelId":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelName":{"type":"string"},"channelUsername":{"type":"string"},"description":{"type":"string"},"subscribers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"videos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avatarUrl":{"type":"string","format":"uri"},"bannerUrl":{"type":"string","format":"uri"},"country":{"type":"string"},"joinedDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"totalViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"video"},"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"isShort":{"type":"boolean"},"isLive":{"type":"boolean"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["type","videoUrl","isShort","isLive"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"playlist"},"playlistId":{"type":"string"},"playlistUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"videos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"}},"required":["type","playlistUrl"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"post"},"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"text":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoId":{"type":"string"},"videoTitle":{"type":"string"},"pollChoices":{"type":"array","items":{"type":"string"}},"pollTotalVotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","postUrl"]}]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/youtube/playlist":{"post":{"operationId":"youtubePlaylist","summary":"Get a playlist and a page of its videos","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"playlist":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["playlist"],"additionalProperties":false},"example":{"playlist":"PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"playlistId":{"type":"string"},"playlistUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"videos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"video"},"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelUrl":{"type":"string","format":"uri"},"channelUsername":{"type":"string"},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"isShort":{"type":"boolean"},"isLive":{"type":"boolean"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["type","videoUrl","isShort","isLive"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/reddit/search":{"post":{"operationId":"redditSearch","summary":"Search Reddit posts, comments, subreddits and users","description":"Costs 1 credit per call. Pages with cursor. Works without an API key, within free limits.","security":[{},{"apiKey":[]}],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":512,"description":"Words to find. With any sort other than relevance, a query of several words matches that exact phrase; use sort relevance to match the words anywhere in a post. Quotes, AND, OR, NOT, title:, selftext:, author:, subreddit: and site: are used as typed."},"type":{"default":"posts","type":"string","enum":["posts","subreddits","users"]},"subreddit":{"type":"string"},"sort":{"default":"relevance","description":"relevance matches the words anywhere in a post. hot, top, newest and mostComments match the exact phrase, so a query of several words only returns posts containing that phrase.","type":"string","enum":["relevance","hot","top","newest","mostComments"]},"within":{"default":"all","type":"string","enum":["hour","day","week","month","year","all"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["query"],"additionalProperties":false},"example":{"query":"typescript"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"post"},"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"subreddit":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upvotePercent":{"type":"number","minimum":0,"maximum":100},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"flair":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"},"isVideo":{"type":"boolean"},"isPinned":{"type":"boolean"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrl":{"type":"string","format":"uri"},"videoHlsUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"pollOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"votes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"pollTotalVotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pollEndsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"repostOfUrl":{"type":"string","format":"uri"}},"required":["type","postUrl","score","comments","isNsfw","isVideo","isPinned"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"subreddit"},"subredditId":{"type":"string"},"subredditName":{"type":"string"},"subredditUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"members":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"avatarUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"}},"required":["type","subredditUrl","isNsfw"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"user"},"userId":{"type":"string"},"username":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"postKarma":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"commentKarma":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"avatarUrl":{"type":"string","format":"uri"},"isVerified":{"type":"boolean"}},"required":["type","userUrl","isVerified"]}]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/reddit/post":{"post":{"operationId":"redditPost","summary":"Read a post and its comment thread","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"post":{"type":"string"},"sort":{"default":"best","type":"string","enum":["best","top","newest"]}},"required":["post"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"subreddit":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upvotePercent":{"type":"number","minimum":0,"maximum":100},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"flair":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"},"isVideo":{"type":"boolean"},"isPinned":{"type":"boolean"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrl":{"type":"string","format":"uri"},"videoHlsUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"pollOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"votes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"pollTotalVotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pollEndsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"repostOfUrl":{"type":"string","format":"uri"},"commentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"commentId":{"type":"string"},"commentUrl":{"type":"string","format":"uri"},"parentId":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"text":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"depth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isSubmitter":{"type":"boolean"},"isPinned":{"type":"boolean"}},"required":["commentUrl","score","depth","isSubmitter","isPinned"]}}},"required":["postUrl","score","isNsfw","isVideo","isPinned","imageUrls","pollOptions","commentCount","comments"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/reddit/subreddit":{"post":{"operationId":"redditSubreddit","summary":"Get a subreddit's info and a page of its posts","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subreddit":{"type":"string"},"sort":{"default":"hot","type":"string","enum":["hot","newest","top"]},"within":{"default":"all","type":"string","enum":["hour","day","week","month","year","all"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["subreddit"],"additionalProperties":false},"example":{"subreddit":"AskReddit"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"subredditId":{"type":"string"},"subredditName":{"type":"string"},"subredditUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"members":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"avatarUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"},"rules":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string"},"description":{"type":"string"}},"required":[]}},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"post"},"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"subreddit":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upvotePercent":{"type":"number","minimum":0,"maximum":100},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"flair":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"},"isVideo":{"type":"boolean"},"isPinned":{"type":"boolean"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrl":{"type":"string","format":"uri"},"videoHlsUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"pollOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"votes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"pollTotalVotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pollEndsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"repostOfUrl":{"type":"string","format":"uri"}},"required":["type","postUrl","score","comments","isNsfw","isVideo","isPinned"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/reddit/user":{"post":{"operationId":"redditUser","summary":"Get a user's profile and a page of their posts and comments","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string"},"tab":{"default":"overview","type":"string","enum":["overview","posts","comments"]},"sort":{"default":"newest","type":"string","enum":["newest","hot","top"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["profile"],"additionalProperties":false},"example":{"profile":"spez"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string"},"username":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"postKarma":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"commentKarma":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"avatarUrl":{"type":"string","format":"uri"},"isVerified":{"type":"boolean"},"results":{"type":"array","items":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"post"},"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"subreddit":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upvotePercent":{"type":"number","minimum":0,"maximum":100},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"flair":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"},"isVideo":{"type":"boolean"},"isPinned":{"type":"boolean"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrl":{"type":"string","format":"uri"},"videoHlsUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"pollOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"votes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"pollTotalVotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pollEndsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"repostOfUrl":{"type":"string","format":"uri"}},"required":["type","postUrl","score","comments","isNsfw","isVideo","isPinned"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"comment"},"commentId":{"type":"string"},"commentUrl":{"type":"string","format":"uri"},"text":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"subreddit":{"type":"string"},"postId":{"type":"string"},"postTitle":{"type":"string"}},"required":["type","commentUrl","score"]}]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/reddit/domain":{"post":{"operationId":"redditDomain","summary":"Get Reddit posts that link to a website","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"},"sort":{"default":"newest","type":"string","enum":["hot","newest","top"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["domain"],"additionalProperties":false},"example":{"domain":"github.com"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","const":"post"},"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"subreddit":{"type":"string"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upvotePercent":{"type":"number","minimum":0,"maximum":100},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"flair":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"isNsfw":{"type":"boolean"},"isVideo":{"type":"boolean"},"isPinned":{"type":"boolean"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrl":{"type":"string","format":"uri"},"videoHlsUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"pollOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"votes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"pollTotalVotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pollEndsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"repostOfUrl":{"type":"string","format":"uri"}},"required":["type","postUrl","score","comments","isNsfw","isVideo","isPinned"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/maps/search":{"post":{"operationId":"mapsSearch","summary":"Search places on Google Maps by keyword and location","description":"Costs 1 credit per call. Works without an API key, within free limits.","security":[{},{"apiKey":[]}],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"location":{"type":"string","minLength":2,"maxLength":200},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"default":"en","type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."}},"required":["query","location"],"additionalProperties":false},"example":{"query":"coffee","location":"Austin, TX"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"placeId":{"type":"string"},"googlePlaceId":{"type":"string"},"placeUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"rating":{"type":"number"},"photos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"phone":{"type":"string"},"website":{"type":"string","format":"uri"},"description":{"type":"string"},"hoursToday":{"type":"string"},"openStatus":{"type":"string"},"timezone":{"type":"string"},"plusCode":{"type":"string"},"thumbnailUrl":{"type":"string","format":"uri"},"reservationUrl":{"type":"string","format":"uri"},"attributes":{"type":"array","items":{"type":"string"}}},"required":["placeUrl","latitude","longitude"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/maps/place":{"post":{"operationId":"mapsPlace","summary":"Get a place's address, hours, rating and contact details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string"},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"default":"en","type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."}},"required":["place"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"placeId":{"type":"string"},"googlePlaceId":{"type":"string"},"placeUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"rating":{"type":"number"},"photos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"phone":{"type":"string"},"website":{"type":"string","format":"uri"},"description":{"type":"string"},"hoursToday":{"type":"string"},"openStatus":{"type":"string"},"timezone":{"type":"string"},"plusCode":{"type":"string"},"thumbnailUrl":{"type":"string","format":"uri"},"reservationUrl":{"type":"string","format":"uri"},"attributes":{"type":"array","items":{"type":"string"}}},"required":["placeUrl","categories","latitude","longitude","attributes"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/maps/reviews":{"post":{"operationId":"mapsReviews","summary":"Get a place's reviews","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string"},"sort":{"default":"newest","type":"string","enum":["relevance","newest","highest","lowest"]},"language":{"default":"en","type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["place"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"reviewId":{"type":"string"},"reviewUrl":{"type":"string","format":"uri"},"rating":{"type":"integer","minimum":1,"maximum":5},"text":{"type":"string"},"language":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorReviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorPhotos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorIsLocalGuide":{"type":"boolean"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"details":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"value":{"type":"string"},"rating":{"type":"number"}},"required":[]}},"ownerReplyText":{"type":"string"},"ownerReplyAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["rating","authorIsLocalGuide"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/instagram/profile":{"post":{"operationId":"instagramProfile","summary":"Get a profile's bio, stats and a page of its posts and reels","description":"Costs 2 credits per call. Pages with cursor.","x-credits":2,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["profile"],"additionalProperties":false},"example":{"profile":"natgeo"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string"},"username":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"bio":{"type":"string"},"bioLinkUrls":{"type":"array","items":{"type":"string","format":"uri"}},"pronouns":{"type":"array","items":{"type":"string"}},"isVerified":{"type":"boolean"},"isPrivate":{"type":"boolean"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"following":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"posts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avatarUrl":{"type":"string","format":"uri"},"postsAnalyzed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"averageLikes":{"type":"number"},"averageComments":{"type":"number"},"engagementRate":{"type":"number"},"postsPerWeek":{"type":"number"},"lastPostAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"postId":{"type":"string"},"postCode":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"type":{"type":"string","enum":["photo","video","reel","carousel"]},"text":{"type":"string"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrls":{"type":"array","items":{"type":"string","format":"uri"}},"imageDescription":{"type":"string"},"isPinned":{"type":"boolean"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"taggedUsers":{"type":"array","items":{"type":"string"}},"coauthors":{"type":"array","items":{"type":"string"}},"audioTitle":{"type":"string"},"audioArtist":{"type":"string"},"audioIsOriginal":{"type":"boolean"},"isPaidPartnership":{"type":"boolean"},"sponsors":{"type":"array","items":{"type":"string"}}},"required":["postUrl","type","isPinned","authorIsVerified","isPaidPartnership"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/instagram/post":{"post":{"operationId":"instagramPost","summary":"Get a post or reel, with its top comments","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"post":{"type":"string"}},"required":["post"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"postId":{"type":"string"},"postCode":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"type":{"type":"string","enum":["photo","video","reel","carousel"]},"text":{"type":"string"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrls":{"type":"array","items":{"type":"string","format":"uri"}},"imageDescription":{"type":"string"},"isPinned":{"type":"boolean"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"taggedUsers":{"type":"array","items":{"type":"string"}},"coauthors":{"type":"array","items":{"type":"string"}},"audioTitle":{"type":"string"},"audioArtist":{"type":"string"},"audioIsOriginal":{"type":"boolean"},"isPaidPartnership":{"type":"boolean"},"sponsors":{"type":"array","items":{"type":"string"}},"commentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"commentId":{"type":"string"},"commentUrl":{"type":"string","format":"uri"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"text":{"type":"string"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replies":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["commentUrl","authorIsVerified"]}}},"required":["postUrl","type","hashtags","mentions","imageUrls","videoUrls","isPinned","authorIsVerified","taggedUsers","coauthors","isPaidPartnership","sponsors","comments"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/instagram/comments":{"post":{"operationId":"instagramComments","summary":"Get a post's comments, or the replies to one comment","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"post":{"type":"string"},"comment":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["post"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"commentId":{"type":"string"},"commentUrl":{"type":"string","format":"uri"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"text":{"type":"string"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replies":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["commentUrl","authorIsVerified"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tiktok/profile":{"post":{"operationId":"tiktokProfile","summary":"Get a profile's bio, stats and a page of its videos","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["profile"],"additionalProperties":false},"example":{"profile":"khaby.lame"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string"},"username":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"bio":{"type":"string"},"bioLinkUrl":{"type":"string","format":"uri"},"avatarUrl":{"type":"string","format":"uri"},"isVerified":{"type":"boolean"},"isPrivate":{"type":"boolean"},"isOrganization":{"type":"boolean"},"language":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"following":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"videos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"type":{"type":"string","enum":["video","photo"]},"text":{"type":"string"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"durationSeconds":{"type":"number"},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shares":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"audioId":{"type":"string"},"audioTitle":{"type":"string"},"audioArtist":{"type":"string"},"audioIsOriginal":{"type":"boolean"},"isAd":{"type":"boolean"},"isAiGenerated":{"type":"boolean"}},"required":["videoUrl","type","authorUrl","authorIsVerified","isAd","isAiGenerated"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tiktok/video":{"post":{"operationId":"tiktokVideo","summary":"Get a video's caption, stats and music","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"type":"string"}},"required":["video"],"additionalProperties":false},"example":{"video":"7652012587009215774"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"type":{"type":"string","enum":["video","photo"]},"text":{"type":"string"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"durationSeconds":{"type":"number"},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shares":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"audioId":{"type":"string"},"audioTitle":{"type":"string"},"audioArtist":{"type":"string"},"audioIsOriginal":{"type":"boolean"},"country":{"type":"string"},"isAd":{"type":"boolean"},"isAiGenerated":{"type":"boolean"}},"required":["videoUrl","type","hashtags","mentions","imageUrls","authorUrl","authorIsVerified","isAd","isAiGenerated"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tiktok/hashtag":{"post":{"operationId":"tiktokHashtag","summary":"Get a page of videos for a hashtag","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hashtag":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["hashtag"],"additionalProperties":false},"example":{"hashtag":"booktok"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"type":{"type":"string","enum":["video","photo"]},"text":{"type":"string"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"durationSeconds":{"type":"number"},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shares":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"audioId":{"type":"string"},"audioTitle":{"type":"string"},"audioArtist":{"type":"string"},"audioIsOriginal":{"type":"boolean"},"isAd":{"type":"boolean"},"isAiGenerated":{"type":"boolean"}},"required":["videoUrl","type","authorUrl","authorIsVerified","isAd","isAiGenerated"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tiktok/comments":{"post":{"operationId":"tiktokComments","summary":"Get a video's comments, or the replies to one comment","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"type":"string"},"comment":{"type":"string","pattern":"^\\d{5,25}$"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["video"],"additionalProperties":false},"example":{"video":"7652012587009215774"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"commentId":{"type":"string"},"text":{"type":"string"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replies":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["authorUrl","likes","replies"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tiktok/search":{"post":{"operationId":"tiktokSearch","summary":"Search TikTok videos and users","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"type":{"default":"videos","type":"string","enum":["videos","users"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["query"],"additionalProperties":false},"example":{"query":"street food"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"videoId":{"type":"string"},"videoUrl":{"type":"string","format":"uri"},"type":{"type":"string","enum":["video","photo"]},"text":{"type":"string"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"durationSeconds":{"type":"number"},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shares":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"audioId":{"type":"string"},"audioTitle":{"type":"string"},"audioArtist":{"type":"string"},"audioIsOriginal":{"type":"boolean"},"isAd":{"type":"boolean"},"isAiGenerated":{"type":"boolean"}},"required":["videoUrl","type","authorUrl","authorIsVerified","isAd","isAiGenerated"]},{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string"},"username":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"bio":{"type":"string"},"avatarUrl":{"type":"string","format":"uri"},"isVerified":{"type":"boolean"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["userUrl","isVerified"]}]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/meta/ads/page":{"post":{"operationId":"metaAdsPage","summary":"Get the ads a Facebook page runs","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"advertiser":{"description":"The Facebook page: its id, name or URL.","type":"string"},"country":{"default":"us","pattern":"^(?:[A-Za-z]{2}|[Aa][Ll][Ll])$","description":"ISO 3166-1 alpha-2 country code, or all. Any case is accepted.","type":"string"},"status":{"default":"active","type":"string","enum":["active","inactive","all"]},"mediaType":{"description":"Only ads with this creative: image, video, or text (no image or video).","type":"string","enum":["image","video","text"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["advertiser"],"additionalProperties":false},"example":{"advertiser":"https://www.facebook.com/nike"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserId":{"description":"Same as pageId. Present so this ad has the same keys as other ad networks.","type":"string"},"advertiserName":{"description":"Same as pageName. Present so this ad has the same keys as other ad networks.","type":"string"},"advertiserUrl":{"description":"Same as pageUrl. Present so this ad has the same keys as other ad networks.","type":"string","format":"uri"},"advertiserAvatarUrl":{"description":"Same as pageAvatarUrl. Present so this ad has the same keys as other ad networks.","type":"string","format":"uri"},"pageId":{"type":"string"},"pageName":{"type":"string"},"pageUrl":{"type":"string","format":"uri"},"pageAvatarUrl":{"type":"string","format":"uri"},"pageCategories":{"type":"array","items":{"type":"string"}},"pageLikes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isActive":{"type":"boolean"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"platforms":{"type":"array","items":{"type":"string"}},"format":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkTitle":{"type":"string"},"linkDescription":{"type":"string"},"ctaText":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrls":{"type":"array","items":{"type":"string","format":"uri"}},"cards":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkTitle":{"type":"string"},"ctaText":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"}},"required":[]}},"versions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"categories":{"type":"array","items":{"type":"string"}},"paidBy":{"type":"string"},"spendMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countries":{"type":"array","items":{"type":"string"}}},"required":["adUrl","isActive","versions"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/jobs/search":{"post":{"operationId":"linkedinJobsSearch","summary":"Search LinkedIn jobs","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"within":{"default":"all","type":"string","enum":["day","week","month","all"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":100}},"additionalProperties":false},"example":{"query":"product manager","location":"New York"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string"},"jobUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"companyName":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"companyAvatarUrl":{"type":"string","format":"uri"},"location":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"salaryMin":{"type":"number"},"salaryMax":{"type":"number"},"salaryCurrency":{"type":"string"},"salaryPeriod":{"type":"string","enum":["hour","month","year"]},"salaryText":{"type":"string"},"isEasyApply":{"type":"boolean"},"insight":{"type":"string"}},"required":["jobUrl"]}},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/people/search":{"post":{"operationId":"linkedinPeopleSearch","summary":"Find public LinkedIn profiles by job title, company and location, with their details","description":"Costs 1 credit per 10 results, plus 1 credit per result that comes back with details. Pages with page.","x-credits":1,"x-credits-max":11,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"description":"Free words to match, like a skill or industry.","type":"string","minLength":1,"maxLength":120},"title":{"description":"Current job title, like Head of Marketing.","type":"string","minLength":1,"maxLength":120},"company":{"description":"Current company, like Shopify.","type":"string","minLength":1,"maxLength":120},"location":{"description":"City or region shown on the profile, like Toronto.","type":"string","minLength":1,"maxLength":120},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":10}},"additionalProperties":false},"example":{"query":"SaaS","title":"Head of Marketing"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"profileUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"headline":{"type":"string"},"title":{"type":"string"},"company":{"type":"string"},"location":{"type":"string"},"education":{"type":"string"},"details":{"type":"object","additionalProperties":false,"properties":{"profileId":{"type":"string"},"headline":{"type":"string"},"location":{"type":"string"},"about":{"type":"string"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"roles":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string"},"company":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"from":{"type":"string"},"to":{"type":"string"},"isCurrent":{"type":"boolean"}},"required":["isCurrent"]}},"education":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"school":{"type":"string"},"degree":{"type":"string"},"schoolUrl":{"type":"string","format":"uri"},"from":{"type":"string"},"to":{"type":"string"}},"required":[]}}},"required":[]},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["profileUrl","position"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/companies/search":{"post":{"operationId":"linkedinCompaniesSearch","summary":"Find LinkedIn company pages by name, industry and location, with their details","description":"Costs 1 credit per 10 results, plus 1 credit per result that comes back with details. Pages with page.","x-credits":1,"x-credits-max":11,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"description":"Company name or words about what it does.","type":"string","minLength":1,"maxLength":120},"industry":{"description":"Industry, like Financial Services.","type":"string","minLength":1,"maxLength":120},"location":{"description":"Headquarters city or region, like New York.","type":"string","minLength":1,"maxLength":120},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":10}},"additionalProperties":false},"example":{"industry":"Financial Services","location":"New York"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"companyUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"description":{"type":"string"},"industry":{"type":"string"},"size":{"type":"string"},"headquarters":{"type":"string"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"details":{"type":"object","additionalProperties":false,"properties":{"companyId":{"type":"string"},"website":{"type":"string","format":"uri"},"description":{"type":"string"},"industry":{"type":"string"},"size":{"type":"string"},"employees":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"headquarters":{"type":"string"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"founded":{"type":"string"},"specialties":{"type":"array","items":{"type":"string"}}},"required":[]},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["companyUrl","position"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/jobs/job":{"post":{"operationId":"linkedinJobsJob","summary":"Get a LinkedIn job's details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"job":{"type":"string"}},"required":["job"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string"},"jobUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"companyName":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"companyAvatarUrl":{"type":"string","format":"uri"},"location":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"salaryMin":{"type":"number"},"salaryMax":{"type":"number"},"salaryCurrency":{"type":"string"},"salaryPeriod":{"type":"string","enum":["hour","month","year"]},"salaryText":{"type":"string"},"isEasyApply":{"type":"boolean"},"applicants":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"applyUrl":{"type":"string","format":"uri"},"seniority":{"type":"string"},"employmentType":{"type":"string"},"jobFunction":{"type":"string"},"industries":{"type":"string"},"description":{"type":"string"}},"required":["jobUrl"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/company":{"post":{"operationId":"linkedinCompany","summary":"Get a company's profile, size and industry","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"string"}},"required":["company"],"additionalProperties":false},"example":{"company":"microsoft"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"companyId":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"industry":{"type":"string"},"size":{"type":"string"},"employees":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"headquarters":{"type":"string"},"website":{"type":"string","format":"uri"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":{"type":"string"},"specialties":{"type":"array","items":{"type":"string"}},"founded":{"type":"string"}},"required":["companyUrl","specialties"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/profile":{"post":{"operationId":"linkedinProfile","summary":"Get a person's profile","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string"}},"required":["profile"],"additionalProperties":false},"example":{"profile":"satyanadella"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"profileId":{"type":"string"},"profileUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"headline":{"type":"string"},"location":{"type":"string"},"about":{"type":"string"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"roles":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string"},"company":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"from":{"type":"string"},"to":{"type":"string"},"isCurrent":{"type":"boolean"}},"required":["isCurrent"]}},"education":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"school":{"type":"string"},"degree":{"type":"string"},"schoolUrl":{"type":"string","format":"uri"},"from":{"type":"string"},"to":{"type":"string"}},"required":[]}}},"required":["profileUrl","roles","education"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/linkedin/posts":{"post":{"operationId":"linkedinPosts","summary":"Get a person's or company's latest public posts","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string"},"company":{"type":"string"}},"additionalProperties":false},"example":{"profile":"satyanadella"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"postId":{"type":"string"},"postUrl":{"type":"string","format":"uri"},"text":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"}},"required":["postUrl"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/zillow/search":{"post":{"operationId":"zillowSearch","summary":"Search homes for sale, for rent or sold","description":"Costs 2 credits per call. Pages with page.","x-credits":2,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","minLength":2,"maxLength":200},"status":{"default":"forSale","type":"string","enum":["forSale","forRent","sold"]},"minPrice":{"type":"number","minimum":0},"maxPrice":{"type":"number","minimum":0},"minBedrooms":{"type":"integer","minimum":0,"maximum":20},"maxBedrooms":{"type":"integer","minimum":0,"maximum":20},"homeTypes":{"minItems":1,"type":"array","items":{"type":"string","enum":["house","townhouse","multiFamily","condo","land","apartment","manufactured"]}},"sort":{"default":"relevance","type":"string","enum":["relevance","newest","priceHigh","priceLow"]},"query":{"type":"string","minLength":1,"maxLength":200},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":20}},"required":["location"],"additionalProperties":false},"example":{"location":"Austin, TX"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"propertyId":{"type":"string"},"propertyUrl":{"type":"string","format":"uri"},"status":{"type":"string","enum":["forSale","forRent","sold","other"]},"statusText":{"type":"string"},"price":{"description":"Asking price, monthly rent, or the sale price of a sold home. Null when Zillow shows none, which includes sold homes in states that keep sale prices private, such as Texas.","type":"number","minimum":0},"priceCurrency":{"type":"string","const":"USD"},"addressFull":{"type":"string"},"addressStreet":{"type":"string"},"addressCity":{"type":"string"},"addressRegion":{"type":"string"},"addressPostalCode":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"bedrooms":{"type":"number"},"bathrooms":{"type":"number"},"sqft":{"type":"number"},"homeType":{"type":"string"},"daysOnZillow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastSoldAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"zestimate":{"type":"number"},"rentZestimate":{"type":"number"},"brokerName":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"buildingName":{"type":"string"},"buildingMinRent":{"type":"number"},"buildingMaxRent":{"type":"number"},"buildingAvailableUnits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"units":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"bedrooms":{"type":"number"},"price":{"type":"number","minimum":0}},"required":[]}}},"required":["propertyUrl","status"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"totalPages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/zillow/property":{"post":{"operationId":"zillowProperty","summary":"Get a home's details, price and Zestimate","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"property":{"type":"string"}},"required":["property"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"propertyId":{"type":"string"},"propertyUrl":{"type":"string","format":"uri"},"status":{"type":"string"},"homeType":{"type":"string"},"price":{"description":"Asking price, monthly rent, or the sale price of a sold home. Null when Zillow shows none, which includes sold homes in states that keep sale prices private, such as Texas.","type":"number","minimum":0},"priceCurrency":{"type":"string","const":"USD"},"zestimate":{"type":"number"},"rentZestimate":{"type":"number"},"lastSoldPrice":{"type":"number"},"lastSoldAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"addressFull":{"type":"string"},"addressStreet":{"type":"string"},"addressCity":{"type":"string"},"addressRegion":{"type":"string"},"addressPostalCode":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"bedrooms":{"type":"number"},"bathrooms":{"type":"number"},"sqft":{"type":"number"},"lotSize":{"type":"number"},"lotSizeUnit":{"type":"string"},"yearBuilt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"priceHistory":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"price":{"type":"number"},"event":{"type":"string"}},"required":["date"]}},"daysOnZillow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"monthlyHoa":{"type":"number"},"propertyTaxRate":{"type":"number"},"mlsId":{"type":"string"},"mlsName":{"type":"string"},"brokerName":{"type":"string"},"brokerPhone":{"type":"string"},"agentName":{"type":"string"},"agentPhone":{"type":"string"},"agentEmail":{"type":"string"},"facts":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":[]}}},"required":["propertyUrl","imageUrls","priceHistory","facts"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/upwork/search":{"post":{"operationId":"upworkSearch","summary":"Search Upwork jobs","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"sort":{"default":"newest","type":"string","enum":["newest","relevance"]},"jobType":{"type":"string","enum":["hourly","fixed"]},"experience":{"type":"string","enum":["entry","intermediate","expert"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":100}},"additionalProperties":false},"example":{"query":"react developer"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string"},"jobUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"skills":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["hourly","fixed"]},"experience":{"type":"string","enum":["entry","intermediate","expert"]},"hourlyRateMin":{"type":"number"},"hourlyRateMax":{"type":"number"},"fixedBudget":{"type":"number"},"budgetCurrency":{"type":"string"},"durationWeeks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["jobUrl"]}},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"totalPages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/upwork/job":{"post":{"operationId":"upworkJob","summary":"Get an Upwork job's details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"job":{"type":"string"}},"required":["job"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string"},"jobUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"skills":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["hourly","fixed"]},"experience":{"type":"string","enum":["entry","intermediate","expert"]},"hourlyRateMin":{"type":"number"},"hourlyRateMax":{"type":"number"},"fixedBudget":{"type":"number"},"budgetCurrency":{"type":"string"},"durationWeeks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"status":{"type":"string"},"category":{"type":"string"},"categoryGroup":{"type":"string"},"durationText":{"type":"string"},"applicants":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"interviewing":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invitesSent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unansweredInvites":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"positions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastClientActivityAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"clientCity":{"type":"string"},"clientCountry":{"type":"string"},"clientTimezone":{"type":"string"},"clientTotalSpent":{"type":"number"},"clientHires":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clientJobsWithHires":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clientActiveContracts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clientReviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clientRating":{"type":"number"},"clientOpenJobs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clientPostedJobs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clientJoinedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"clientIndustry":{"type":"string"},"clientCompanySize":{"type":"string"}},"required":["jobUrl","skills"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/indeed/search":{"post":{"operationId":"indeedSearch","summary":"Search Indeed jobs","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","maxLength":200},"location":{"description":"City, region or postal code, e.g. Kansas City, MO. Only jobs within about 5 miles are returned, so a city on a state line stays in its own state.","type":"string","minLength":2,"maxLength":200},"country":{"default":"us","enum":["us","gb","ca","au","nz","ie","in","sg","my","ph","za","ng","ae","sa","qa","kw","bh","om","pk","hk","jp","kr","tw","cn","id","th","vn","de","at","ch","fr","be","nl","lu","es","pt","it","gr","pl","cz","hu","ro","fi","se","no","dk","ua","tr","il","eg","ma","mx","br","ar","cl","co","pe","ec","uy","ve","cr","pa"],"description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.","type":"string"},"remote":{"default":false,"type":"boolean"},"within":{"description":"Jobs Indeed listed or relisted in this window. A relisted job keeps its first publishedAt and shows the new date in indexedAt.","type":"string","enum":["day","week","month"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"additionalProperties":false},"example":{"query":"data analyst","location":"Chicago, IL"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string"},"jobUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"companyName":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"companyAvatarUrl":{"type":"string","format":"uri"},"companyWebsite":{"type":"string","format":"uri"},"companyIndustry":{"type":"string"},"companyEmployeesText":{"type":"string"},"companyRevenueText":{"type":"string"},"companyDescription":{"type":"string"},"addressFull":{"type":"string"},"addressCity":{"type":"string"},"addressRegion":{"type":"string"},"addressPostalCode":{"type":"string"},"addressCountry":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"salaryMin":{"type":"number"},"salaryMax":{"type":"number"},"salaryPeriod":{"type":"string","enum":["hour","day","week","month","year"]},"salaryCurrency":{"type":"string"},"salaryIsEstimate":{"type":"boolean"},"jobTypes":{"type":"array","items":{"type":"string","enum":["fullTime","partTime","contract","internship"]}},"isRemote":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"indexedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"applyUrl":{"type":"string","format":"uri"},"isEasyApply":{"type":"boolean"},"isUrgent":{"type":"boolean"},"source":{"type":"string"},"description":{"type":"string"}},"required":["jobUrl","salaryIsEstimate","isRemote","isEasyApply","isUrgent"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/indeed/job":{"post":{"operationId":"indeedJob","summary":"Get an Indeed job's details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"job":{"type":"string"},"country":{"enum":["us","gb","ca","au","nz","ie","in","sg","my","ph","za","ng","ae","sa","qa","kw","bh","om","pk","hk","jp","kr","tw","cn","id","th","vn","de","at","ch","fr","be","nl","lu","es","pt","it","gr","pl","cz","hu","ro","fi","se","no","dk","ua","tr","il","eg","ma","mx","br","ar","cl","co","pe","ec","uy","ve","cr","pa"],"description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.","type":"string"}},"required":["job"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string"},"jobUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"companyName":{"type":"string"},"companyUrl":{"type":"string","format":"uri"},"companyAvatarUrl":{"type":"string","format":"uri"},"companyWebsite":{"type":"string","format":"uri"},"companyIndustry":{"type":"string"},"companyEmployeesText":{"type":"string"},"companyRevenueText":{"type":"string"},"companyDescription":{"type":"string"},"addressFull":{"type":"string"},"addressCity":{"type":"string"},"addressRegion":{"type":"string"},"addressPostalCode":{"type":"string"},"addressCountry":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"salaryMin":{"type":"number"},"salaryMax":{"type":"number"},"salaryPeriod":{"type":"string","enum":["hour","day","week","month","year"]},"salaryCurrency":{"type":"string"},"salaryIsEstimate":{"type":"boolean"},"jobTypes":{"type":"array","items":{"type":"string","enum":["fullTime","partTime","contract","internship"]}},"isRemote":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string"}},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"indexedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"applyUrl":{"type":"string","format":"uri"},"isEasyApply":{"type":"boolean"},"isUrgent":{"type":"boolean"},"source":{"type":"string"},"description":{"type":"string"},"descriptionHtml":{"type":"string"},"isExpired":{"type":"boolean"},"language":{"type":"string"}},"required":["jobUrl","salaryIsEstimate","jobTypes","isRemote","attributes","isEasyApply","isUrgent","isExpired"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tripadvisor/search":{"post":{"operationId":"tripadvisorSearch","summary":"Search hotels, restaurants and attractions","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":2,"maxLength":200},"type":{"default":"all","type":"string","enum":["all","hotels","restaurants","attractions","geos"]}},"required":["query"],"additionalProperties":false},"example":{"query":"Eiffel Tower"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"placeId":{"type":"string"},"placeUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"type":{"type":"string"},"address":{"type":"string"},"parent":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"imageUrl":{"type":"string","format":"uri"}},"required":[]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tripadvisor/place":{"post":{"operationId":"tripadvisorPlace","summary":"Get a place's rating, ranking and details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string"}},"required":["place"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"placeId":{"type":"string"},"placeUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"type":{"type":"string"},"subtypes":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rankingText":{"type":"string"},"rankingPosition":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rankingOf":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rankingGeo":{"type":"string"},"priceLevel":{"type":"string"},"priceRangeText":{"type":"string"},"hotelClass":{"type":"number"},"description":{"type":"string"},"addressFull":{"type":"string"},"addressStreet":{"type":"string"},"addressCity":{"type":"string"},"addressRegion":{"type":"string"},"addressCountry":{"type":"string"},"addressPostalCode":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"phone":{"type":"string"},"website":{"type":"string","format":"uri"},"email":{"type":"string"},"neighborhoods":{"type":"array","items":{"type":"string"}},"parents":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"placeId":{"type":"string"},"name":{"type":"string"}},"required":[]}},"cuisines":{"type":"array","items":{"type":"string"}},"hours":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"days":{"type":"string"},"times":{"type":"array","items":{"type":"string"}}},"required":[]}},"tags":{"type":"array","items":{"type":"string"}},"imageUrl":{"type":"string","format":"uri"},"timezone":{"type":"string"},"isClosed":{"type":"boolean"}},"required":["subtypes","neighborhoods","parents","cuisines","hours","tags","isClosed"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/tripadvisor/reviews":{"post":{"operationId":"tripadvisorReviews","summary":"Get a place's reviews","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string"},"language":{"default":"en","type":"string","pattern":"^(?:[Aa][Ll][Ll]|[A-Za-z]{2}(?:-[A-Za-z]{2})?)$"},"ratings":{"default":[],"maxItems":5,"type":"array","items":{"type":"integer","minimum":1,"maximum":5}},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":500}},"required":["place"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"placeId":{"type":"string"},"placeName":{"type":"string"},"placeType":{"type":"string"},"placeUrl":{"type":"string","format":"uri"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"reviewId":{"type":"string"},"reviewUrl":{"type":"string","format":"uri"},"rating":{"type":"number"},"title":{"type":"string"},"text":{"type":"string"},"language":{"type":"string"},"createdDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"publishedDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"stayDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"tripType":{"type":"string"},"helpful":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subRatings":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"rating":{"type":"number"}},"required":["rating"]}},"authorName":{"type":"string"},"authorUsername":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAddress":{"type":"string"},"authorContributions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ownerReplyText":{"type":"string"},"ownerReplyDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"ownerReplyAuthor":{"type":"string"}},"required":["helpful"]}},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/googletravel/flights":{"post":{"operationId":"googletravelFlights","summary":"Search flights with prices and times","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"origin":{"type":"string","pattern":"^[A-Za-z]{3}$","description":"IATA airport code, e.g. JFK. Any case is accepted."},"destination":{"type":"string","pattern":"^[A-Za-z]{3}$","description":"IATA airport code, e.g. JFK. Any case is accepted."},"departDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"returnDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"adults":{"default":1,"type":"integer","minimum":1,"maximum":9},"cabin":{"default":"economy","type":"string","enum":["economy","premiumEconomy","business","first"]}},"required":["origin","destination","departDate"],"additionalProperties":false},"example":{"origin":"JFK","destination":"LAX","departDate":"2026-11-19"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"cabin":{"type":"string","enum":["economy","premiumEconomy","business","first"]},"tripType":{"type":"string","enum":["oneWay","roundTrip"]},"adults":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"isBest":{"type":"boolean"},"price":{"description":"Total fare in USD for all adults together. For a round trip it covers both directions.","type":"number"},"priceCurrency":{"type":"string","const":"USD"},"airlines":{"type":"array","items":{"type":"string"}},"stops":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"departureLocalTime":{"description":"Local time at the airport, YYYY-MM-DDTHH:mm, no time zone.","type":"string"},"arrivalLocalTime":{"description":"Local time at the airport, YYYY-MM-DDTHH:mm, no time zone.","type":"string"},"legs":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"flightNumber":{"type":"string"},"airline":{"type":"string"},"originCode":{"type":"string"},"originName":{"type":"string"},"destinationCode":{"type":"string"},"destinationName":{"type":"string"},"departureLocalTime":{"description":"Local time at the airport, YYYY-MM-DDTHH:mm, no time zone.","type":"string"},"arrivalLocalTime":{"description":"Local time at the airport, YYYY-MM-DDTHH:mm, no time zone.","type":"string"},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"aircraft":{"type":"string"},"legroom":{"type":"string"}},"required":[]},"description":"The outbound journey only, including a return search."},"layovers":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"airport":{"type":"string"},"name":{"type":"string"},"city":{"type":"string"},"durationSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"emissionsGrams":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"typicalEmissionsGrams":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["isBest","stops"]},"description":"Outbound flight options. With returnDate, each price is the round-trip total for that outbound choice."}},"required":["cabin","tripType","adults","results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/walmart/search":{"post":{"operationId":"walmartSearch","summary":"Search Walmart products","description":"Costs 4 credits per call. Pages with page.","x-credits":4,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":300},"sort":{"default":"relevance","type":"string","enum":["relevance","priceLow","priceHigh","bestSelling","highest","newest"]},"minPrice":{"type":"number","minimum":0},"maxPrice":{"type":"number","minimum":0},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":25}},"required":["query"],"additionalProperties":false},"example":{"query":"air fryer"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"productId":{"type":"string"},"productUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"price":{"type":"number","minimum":0},"originalPrice":{"type":"number","minimum":0},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"rating":{"type":"number"},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sellerName":{"type":"string"},"availability":{"type":"string"},"isSponsored":{"type":"boolean"}},"required":["productUrl","isSponsored"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"totalPages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/walmart/product":{"post":{"operationId":"walmartProduct","summary":"Get a Walmart product's price and details","description":"Costs 3 credits per call.","x-credits":3,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"string"}},"required":["product"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"productId":{"type":"string"},"productUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number","minimum":0},"originalPrice":{"type":"number","minimum":0},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"availability":{"type":"string"},"rating":{"type":"number"},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sellerName":{"type":"string"},"sellerId":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"description":{"type":"string"},"highlights":{"type":"string"},"specs":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":[]}},"variants":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":[]}},"upc":{"type":"string"},"model":{"type":"string"},"topReviews":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"reviewId":{"type":"string"},"authorName":{"type":"string"},"rating":{"type":"number"},"title":{"type":"string"},"text":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"helpful":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}}},"required":["productUrl","categories","imageUrls","specs","variants","topReviews"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/appstore/app":{"post":{"operationId":"appstoreApp","summary":"Get an app's details from the App Store","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."}},"required":["app"],"additionalProperties":false},"example":{"app":"284882215"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"appId":{"type":"string"},"appUrl":{"type":"string","format":"uri"},"bundleId":{"type":"string"},"name":{"type":"string"},"subtitle":{"type":"string"},"developerId":{"type":"string"},"developerName":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"seller":{"type":"string"},"website":{"type":"string","format":"uri"},"price":{"type":"number"},"priceCurrency":{"type":"string"},"priceText":{"type":"string"},"hasInAppPurchases":{"type":"boolean"},"genres":{"type":"array","items":{"type":"string"}},"primaryGenreId":{"type":"string"},"primaryGenre":{"type":"string"},"contentRating":{"type":"string"},"description":{"type":"string"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"releasedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"minimumOsVersion":{"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"languages":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"ratings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsOne":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsTwo":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsThree":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsFour":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsFive":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"chartName":{"type":"string"},"chartGenre":{"type":"string"},"chartPosition":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"iconUrl":{"type":"string","format":"uri"},"screenshotUrls":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshotUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["appUrl","genres","languages","screenshotUrls","ipadScreenshotUrls"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/appstore/search":{"post":{"operationId":"appstoreSearch","summary":"Search App Store apps","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":100},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"device":{"default":"iphone","type":"string","enum":["iphone","ipad","mac"]}},"required":["query"],"additionalProperties":false},"example":{"query":"photo editor"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"appId":{"type":"string"},"appUrl":{"type":"string","format":"uri"},"bundleId":{"type":"string"},"name":{"type":"string"},"developerId":{"type":"string"},"developerName":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"seller":{"type":"string"},"website":{"type":"string","format":"uri"},"price":{"type":"number"},"priceCurrency":{"type":"string"},"priceText":{"type":"string"},"genres":{"type":"array","items":{"type":"string"}},"primaryGenreId":{"type":"string"},"primaryGenre":{"type":"string"},"contentRating":{"type":"string"},"description":{"type":"string"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"releasedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"minimumOsVersion":{"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"languages":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"ratings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"iconUrl":{"type":"string","format":"uri"},"screenshotUrls":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshotUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["appUrl"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/appstore/reviews":{"post":{"operationId":"appstoreReviews","summary":"Get an app's App Store reviews","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"sort":{"default":"newest","type":"string","enum":["newest","helpful","highest","lowest"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":500}},"required":["app"],"additionalProperties":false},"example":{"app":"284882215"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"reviewId":{"type":"string"},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string"},"text":{"type":"string"},"authorName":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"isEdited":{"type":"boolean"}},"required":["rating","isEdited"]}},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/appstore/top":{"post":{"operationId":"appstoreTop","summary":"Get App Store top charts","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chart":{"default":"free","type":"string","enum":["free","paid","grossing"]},"device":{"default":"iphone","type":"string","enum":["iphone","ipad","mac"]},"genre":{"type":"string","enum":["business","weather","utilities","travel","sports","socialNetworking","reference","productivity","photoVideo","news","navigation","music","lifestyle","healthFitness","games","finance","entertainment","education","books","medical","foodDrink","shopping","developerTools","graphicsDesign"]},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."}},"additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"rank":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"appId":{"type":"string"},"appUrl":{"type":"string","format":"uri"},"bundleId":{"type":"string"},"name":{"type":"string"},"developerId":{"type":"string"},"developerName":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"price":{"type":"number"},"priceCurrency":{"type":"string"},"genreId":{"type":"string"},"genre":{"type":"string"},"releasedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"summary":{"type":"string"},"iconUrl":{"type":"string","format":"uri"}},"required":["rank","appUrl"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/googleplay/app":{"post":{"operationId":"googleplayApp","summary":"Get an app's details from Google Play","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string"},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"default":"en","type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."}},"required":["app"],"additionalProperties":false},"example":{"app":"com.spotify.music"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"appId":{"type":"string"},"appUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"developerId":{"type":"string"},"developerName":{"type":"string"},"developerEmail":{"type":"string"},"developerWebsite":{"type":"string","format":"uri"},"developerAddress":{"type":"string"},"privacyPolicyUrl":{"type":"string","format":"uri"},"genreId":{"type":"string"},"genre":{"type":"string"},"contentRating":{"type":"string"},"installsText":{"type":"string"},"installsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"installsExact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rating":{"type":"number"},"ratings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsOne":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsTwo":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsThree":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsFour":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingsFive":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"price":{"type":"number"},"priceCurrency":{"type":"string"},"hasInAppPurchases":{"type":"boolean"},"inAppPriceText":{"type":"string"},"hasAds":{"type":"boolean"},"version":{"type":"string"},"recentChanges":{"type":"string"},"releasedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"iconUrl":{"type":"string","format":"uri"},"bannerUrl":{"type":"string","format":"uri"},"screenshotUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["appUrl","hasInAppPurchases","hasAds","screenshotUrls"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/googleplay/search":{"post":{"operationId":"googleplaySearch","summary":"Search Google Play apps","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":100},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"default":"en","type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."}},"required":["query"],"additionalProperties":false},"example":{"query":"photo editor"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"appId":{"type":"string"},"appUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"developerName":{"type":"string"},"summary":{"type":"string"},"genre":{"type":"string"},"installsText":{"type":"string"},"installsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rating":{"type":"number"},"price":{"type":"number"},"priceCurrency":{"type":"string"},"iconUrl":{"type":"string","format":"uri"}},"required":["appUrl"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/googleplay/reviews":{"post":{"operationId":"googleplayReviews","summary":"Get an app's Google Play reviews","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string"},"country":{"default":"us","type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"language":{"default":"en","type":"string","pattern":"^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$","description":"BCP 47 language tag, e.g. en or pt-BR. Any case is accepted."},"sort":{"default":"newest","type":"string","enum":["newest","relevance","highest"]},"rating":{"type":"integer","minimum":1,"maximum":5},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["app"],"additionalProperties":false},"example":{"app":"com.spotify.music"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"reviewId":{"type":"string"},"reviewUrl":{"type":"string","format":"uri"},"rating":{"type":"integer","minimum":1,"maximum":5},"text":{"type":"string"},"authorName":{"type":"string"},"authorAvatarUrl":{"type":"string","format":"uri"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"appVersion":{"type":"string"},"ownerReplyText":{"type":"string"},"ownerReplyAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["reviewUrl","rating","likes"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/airbnb/search":{"post":{"operationId":"airbnbSearch","summary":"Search Airbnb stays by place and dates","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","minLength":2,"maxLength":200},"checkIn":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"checkOut":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"adults":{"default":1,"type":"integer","minimum":1,"maximum":16},"minPrice":{"description":"Lowest average nightly rate in USD, before taxes and fees. Compare with pricePerNight, which includes them.","type":"number","minimum":0},"maxPrice":{"description":"Highest average nightly rate in USD, before taxes and fees. Compare with pricePerNight, which includes them.","type":"number","minimum":0}},"required":["location"],"additionalProperties":false},"example":{"location":"Lisbon, Portugal"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"listingId":{"type":"string"},"listingUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"title":{"type":"string"},"subtitle":{"type":"string"},"price":{"description":"Total for the whole stay in USD, taxes and fees included.","type":"number"},"originalPrice":{"description":"Total for the whole stay before a discount, in USD.","type":"number"},"nights":{"description":"Number of nights the price covers. A search without dates is priced for a default 5-night stay.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pricePerNight":{"description":"price divided by nights, in USD, taxes and fees included.","type":"number"},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"priceText":{"type":"string"},"rating":{"type":"number"},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bedrooms":{"type":"number"},"beds":{"type":"number"},"bathrooms":{"type":"number"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"badges":{"type":"array","items":{"type":"string"}},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["listingUrl"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/airbnb/listing":{"post":{"operationId":"airbnbListing","summary":"Get a listing's details, amenities and host","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"listing":{"type":"string"}},"required":["listing"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"listingId":{"type":"string"},"listingUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"headline":{"type":"string"},"description":{"type":"string"},"propertyType":{"type":"string"},"roomType":{"type":"string"},"guests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bedrooms":{"type":"number"},"beds":{"type":"number"},"bathrooms":{"type":"number"},"isPetFriendly":{"type":"boolean"},"isGuestFavorite":{"type":"boolean"},"rating":{"type":"number"},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratingCategories":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"category":{"type":"string"},"rating":{"type":"number"}},"required":["rating"]}},"ratingDistribution":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"stars":{"type":"string"},"percent":{"type":"number"}},"required":["percent"]}},"hostId":{"type":"string"},"hostName":{"type":"string"},"hostIsSuperhost":{"type":"boolean"},"hostIsVerified":{"type":"boolean"},"hostRating":{"type":"number"},"hostReviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hostYearsHosting":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hostBio":{"type":"string"},"hostResponsePercent":{"type":"number"},"hostResponseTime":{"type":"string"},"hostHighlights":{"type":"array","items":{"type":"string"}},"hostAvatarUrl":{"type":"string","format":"uri"},"highlights":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string"},"description":{"type":"string"}},"required":[]}},"amenities":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"group":{"type":"string"},"name":{"type":"string"},"isAvailable":{"type":"boolean"}},"required":["isAvailable"]}},"houseRules":{"type":"array","items":{"type":"string"}},"safety":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"isLocationExact":{"type":"boolean"},"area":{"type":"string"},"neighborhood":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["listingUrl","isGuestFavorite","ratingCategories","ratingDistribution","hostIsSuperhost","hostIsVerified","hostHighlights","highlights","amenities","houseRules","safety","isLocationExact","imageUrls"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/airbnb/calendar":{"post":{"operationId":"airbnbCalendar","summary":"Get a listing's available dates","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"listing":{"type":"string"},"month":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}},"required":["listing"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"isAvailable":{"type":"boolean"},"isBookable":{"type":"boolean"},"isCheckInDay":{"type":"boolean"},"isCheckOutDay":{"type":"boolean"},"minNights":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"maxNights":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","isAvailable","isBookable","isCheckInDay","isCheckOutDay"]}}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/airbnb/reviews":{"post":{"operationId":"airbnbReviews","summary":"Get a listing's reviews","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"listing":{"type":"string"},"sort":{"default":"newest","type":"string","enum":["relevance","newest","highest","lowest"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":400}},"required":["listing"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"reviewId":{"type":"string"},"text":{"type":"string"},"rating":{"type":"number"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"language":{"type":"string"},"stayLength":{"type":"string"},"authorId":{"type":"string"},"authorName":{"type":"string"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorAddress":{"type":"string"},"ownerReplyText":{"type":"string"}},"required":[]}},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/rightmove/search":{"post":{"operationId":"rightmoveSearch","summary":"Search UK homes for sale or rent","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","minLength":2,"maxLength":200},"status":{"default":"forSale","type":"string","enum":["forSale","forRent"]},"minPrice":{"type":"number","minimum":0},"maxPrice":{"type":"number","minimum":0},"minBedrooms":{"type":"integer","minimum":0,"maximum":10},"maxBedrooms":{"type":"integer","minimum":0,"maximum":10},"sort":{"default":"newest","type":"string","enum":["newest","oldest","priceHigh","priceLow"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":42}},"required":["location"],"additionalProperties":false},"example":{"location":"Manchester"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"propertyId":{"type":"string"},"propertyUrl":{"type":"string","format":"uri"},"addressFull":{"type":"string"},"summary":{"type":"string"},"price":{"type":"number","minimum":0},"isPriceOnApplication":{"type":"boolean","description":"True when the agent shows no price (POA); price is then null."},"priceText":{"type":"string"},"priceQualifier":{"type":"string"},"priceFrequency":{"type":"string"},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"bedrooms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bathrooms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"propertyType":{"type":"string"},"sizeText":{"type":"string"},"tenureType":{"type":"string"},"firstListedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updateReason":{"type":"string"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"isFeatured":{"type":"boolean"},"isAuction":{"type":"boolean"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"agentName":{"type":"string"},"agentBranchId":{"type":"string"},"agentPhone":{"type":"string"},"keyFeatures":{"type":"array","items":{"type":"string"}},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["propertyUrl","isPriceOnApplication","isFeatured","isAuction"]}},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["results","page","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/rightmove/property":{"post":{"operationId":"rightmoveProperty","summary":"Get a Rightmove property's details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"property":{"type":"string"}},"required":["property"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"propertyId":{"type":"string"},"propertyUrl":{"type":"string","format":"uri"},"addressFull":{"type":"string"},"addressPostalCode":{"type":"string"},"addressCountry":{"type":"string"},"description":{"type":"string"},"price":{"type":"number","minimum":0},"isPriceOnApplication":{"type":"boolean","description":"True when the agent shows no price (POA); price is then null."},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"priceText":{"type":"string"},"priceQualifier":{"type":"string"},"pricePerSqft":{"type":"number"},"channel":{"type":"string"},"bedrooms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bathrooms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"propertyType":{"type":"string"},"tenureType":{"type":"string"},"tenureYearsRemaining":{"type":"number"},"sizes":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"number"},"unit":{"type":"string"}},"required":["value"]}},"councilTaxBand":{"type":"string"},"annualServiceCharge":{"type":"number"},"annualGroundRent":{"type":"number"},"updateReason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"keyFeatures":{"type":"array","items":{"type":"string"}},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"floorplanUrls":{"type":"array","items":{"type":"string","format":"uri"}},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"nearestStations":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"distanceMiles":{"type":"number"}},"required":[]}},"agentName":{"type":"string"},"agentBranchId":{"type":"string"},"agentPhone":{"type":"string"},"agentCompany":{"type":"string"},"agentAddress":{"type":"string"}},"required":["propertyUrl","isPriceOnApplication","sizes","tags","keyFeatures","imageUrls","floorplanUrls","nearestStations"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/immoscout/search":{"post":{"operationId":"immoscoutSearch","summary":"Search German homes for rent or sale","description":"Costs 1 credit per call. Pages with page.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","minLength":2,"maxLength":200},"type":{"default":"apartmentRent","type":"string","enum":["apartmentRent","apartmentBuy","houseRent","houseBuy","land","flatShare","shortTerm"]},"minPrice":{"type":"number","minimum":0},"maxPrice":{"type":"number","minimum":0},"minRooms":{"type":"number","minimum":0},"sort":{"default":"newest","type":"string","enum":["newest","priceLow","priceHigh","largest"]},"page":{"default":1,"description":"Page number, starting at 1.","type":"integer","minimum":1,"maximum":200}},"required":["location"],"additionalProperties":false},"example":{"location":"Berlin"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"listingId":{"type":"string"},"listingUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"type":{"type":"string"},"addressFull":{"type":"string"},"addressPostalCode":{"type":"string"},"addressCountry":{"type":"string"},"price":{"type":"number"},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"priceText":{"type":"string"},"livingSpace":{"type":"number"},"rooms":{"type":"number"},"energyClass":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"isPrivate":{"type":"boolean"},"isProject":{"type":"boolean"},"isNew":{"type":"boolean"},"imageUrl":{"type":"string","format":"uri"}},"required":["listingUrl","isPrivate","isProject","isNew"]}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"totalPages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["results","page","totalPages","hasMore"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/immoscout/listing":{"post":{"operationId":"immoscoutListing","summary":"Get an ImmoScout listing's details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"listing":{"type":"string"}},"required":["listing"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"listingId":{"type":"string"},"listingUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"addressFull":{"type":"string"},"addressPostalCode":{"type":"string"},"addressCity":{"type":"string"},"addressDistrict":{"type":"string"},"addressCountry":{"type":"string"},"priceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"baseRent":{"type":"number"},"totalRent":{"type":"number"},"serviceCharge":{"type":"number"},"price":{"type":"number"},"livingSpace":{"type":"number"},"rooms":{"type":"number"},"yearBuilt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"energyClass":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"group":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":[]}},"texts":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string"},"text":{"type":"string"}},"required":[]}},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"agentName":{"type":"string"},"agentCompany":{"type":"string"},"agentPhone":{"type":"string"},"agentRating":{"type":"number"},"agentUrl":{"type":"string","format":"uri"},"agentAddress":{"type":"string"}},"required":["listingUrl","attributes","texts","imageUrls"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/pinterest/search":{"post":{"operationId":"pinterestSearch","summary":"Search pins","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"type":{"default":"pins","type":"string","enum":["pins","videos"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["query"],"additionalProperties":false},"example":{"query":"kitchen ideas"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"pinId":{"type":"string"},"pinUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"altText":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"domain":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reposts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reactions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isPromoted":{"type":"boolean"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"boardId":{"type":"string"},"boardName":{"type":"string"},"boardUrl":{"type":"string","format":"uri"}},"required":["pinUrl","isPromoted"]}},"cursor":{"type":"string"}},"required":["results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/pinterest/pin":{"post":{"operationId":"pinterestPin","summary":"Get a pin's details","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pin":{"type":"string"}},"required":["pin"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"pinId":{"type":"string"},"pinUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"altText":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"domain":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reposts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reactions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isPromoted":{"type":"boolean"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"boardId":{"type":"string"},"boardName":{"type":"string"},"boardUrl":{"type":"string","format":"uri"}},"required":["pinUrl","isPromoted"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/pinterest/board":{"post":{"operationId":"pinterestBoard","summary":"Get a board and a page of its pins","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"board":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["board"],"additionalProperties":false}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"boardId":{"type":"string"},"boardUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"pins":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sections":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbnailUrl":{"type":"string","format":"uri"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"pinId":{"type":"string"},"pinUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"altText":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"domain":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reposts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reactions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isPromoted":{"type":"boolean"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"boardId":{"type":"string"},"boardName":{"type":"string"},"boardUrl":{"type":"string","format":"uri"}},"required":["pinUrl","isPromoted"]}},"cursor":{"type":"string"}},"required":["boardUrl","results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/pinterest/user":{"post":{"operationId":"pinterestUser","summary":"Get a profile and a page of its pins","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string"},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["profile"],"additionalProperties":false},"example":{"profile":"marthastewart"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string"},"username":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"name":{"type":"string"},"avatarUrl":{"type":"string","format":"uri"},"followers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bio":{"type":"string"},"website":{"type":"string","format":"uri"},"following":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pins":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"boards":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isVerified":{"type":"boolean"},"isPrivate":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"pinId":{"type":"string"},"pinUrl":{"type":"string","format":"uri"},"title":{"type":"string"},"text":{"type":"string"},"altText":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"domain":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"videoDurationSeconds":{"type":"number"},"saves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reposts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reactions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isPromoted":{"type":"boolean"},"authorId":{"type":"string"},"authorUsername":{"type":"string"},"authorName":{"type":"string"},"authorUrl":{"type":"string","format":"uri"},"authorAvatarUrl":{"type":"string","format":"uri"},"authorIsVerified":{"type":"boolean"},"boardId":{"type":"string"},"boardName":{"type":"string"},"boardUrl":{"type":"string","format":"uri"}},"required":["pinUrl","isPromoted"]}},"cursor":{"type":"string"}},"required":["userUrl","isVerified","isPrivate","results"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/ads/search":{"post":{"operationId":"adsSearch","summary":"Search a public ad library: Meta, Google, TikTok, LinkedIn, Microsoft or Pinterest","description":"Costs 1 credit per call. Pages with cursor.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"network":{"type":"string","const":"meta"},"country":{"default":"us","pattern":"^(?:[A-Za-z]{2}|[Aa][Ll][Ll])$","description":"ISO 3166-1 alpha-2 country code, or all. Any case is accepted.","type":"string"},"status":{"default":"active","type":"string","enum":["active","inactive","all"]},"mediaType":{"description":"Only ads with this creative: image, video, or text (no image or video).","type":"string","enum":["image","video","text"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["query","network"],"additionalProperties":false},{"type":"object","properties":{"network":{"type":"string","const":"google"},"query":{"description":"A domain like nike.com. Google's library finds ads by domain or advertiser, not by keyword.","type":"string","minLength":1,"maxLength":200},"advertiser":{"type":"string"},"domain":{"type":"string"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Country code like de. Only ads shown in this country are returned. Any case is accepted."},"mediaType":{"type":"string","enum":["text","image","video"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["network"],"additionalProperties":false},{"type":"object","properties":{"network":{"type":"string","const":"tiktok"},"query":{"type":"string","minLength":1,"maxLength":200},"advertiser":{"type":"string","minLength":1,"maxLength":200},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"European country code like de. TikTok publishes ads for these countries only. Any case is accepted."},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["network"],"additionalProperties":false},{"type":"object","properties":{"network":{"type":"string","const":"linkedin"},"query":{"type":"string","maxLength":500},"advertiser":{"type":"string","maxLength":500},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted."},"within":{"default":"all","type":"string","enum":["month","year","all"]},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["network"],"additionalProperties":false},{"type":"object","properties":{"network":{"type":"string","const":"microsoft"},"query":{"type":"string","minLength":1,"maxLength":200},"advertiser":{"type":"string","pattern":"^\\d{1,20}$"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"EU/EEA country code like de. Microsoft publishes ads for these countries only. Any case is accepted."},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["network"],"additionalProperties":false},{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"EU country code like fr, or br or tr. Pinterest publishes ads for these countries only. Any case is accepted."},"network":{"type":"string","const":"pinterest"},"query":{"description":"Not supported. Pinterest's ads library has no keyword search. Use advertiser to filter by advertiser name.","type":"string","minLength":1,"maxLength":200},"advertiser":{"description":"Advertiser name to filter by. Pinterest does not publish advertiser names on the ads themselves, so results carry no advertiser.","type":"string","minLength":1,"maxLength":200},"cursor":{"type":"string","minLength":1,"description":"The cursor from the previous response. Send it as is."}},"required":["country","network"],"additionalProperties":false}]},"example":{"network":"meta","query":"nike"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserId":{"description":"Same as pageId. Present so this ad has the same keys as other ad networks.","type":"string"},"advertiserName":{"description":"Same as pageName. Present so this ad has the same keys as other ad networks.","type":"string"},"advertiserUrl":{"description":"Same as pageUrl. Present so this ad has the same keys as other ad networks.","type":"string","format":"uri"},"advertiserAvatarUrl":{"description":"Same as pageAvatarUrl. Present so this ad has the same keys as other ad networks.","type":"string","format":"uri"},"pageId":{"type":"string"},"pageName":{"type":"string"},"pageUrl":{"type":"string","format":"uri"},"pageAvatarUrl":{"type":"string","format":"uri"},"pageCategories":{"type":"array","items":{"type":"string"}},"pageLikes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isActive":{"type":"boolean"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"platforms":{"type":"array","items":{"type":"string"}},"format":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkTitle":{"type":"string"},"linkDescription":{"type":"string"},"ctaText":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrls":{"type":"array","items":{"type":"string","format":"uri"}},"cards":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkTitle":{"type":"string"},"ctaText":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"}},"required":[]}},"versions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"categories":{"type":"array","items":{"type":"string"}},"paidBy":{"type":"string"},"spendMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countries":{"type":"array","items":{"type":"string"}}},"required":["adUrl","isActive","versions"]}},"cursor":{"type":"string"}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"totalMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"advertiserUrl":{"type":"string","format":"uri"},"domain":{"type":"string"},"format":{"type":"string","enum":["text","image","video","unknown"]},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"daysShown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previewUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"}},"required":["adUrl","advertiserUrl","format"]}},"cursor":{"type":"string"}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserName":{"type":"string"},"headline":{"type":"string"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"videoUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["adUrl"]}},"cursor":{"type":"string"}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"creativeType":{"type":"string"},"format":{"type":"string"},"advertiserName":{"type":"string"},"advertiserUrl":{"type":"string","format":"uri"},"advertiserAvatarUrl":{"type":"string","format":"uri"},"postedBy":{"type":"string"},"text":{"type":"string"},"headline":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["adUrl"]}},"cursor":{"type":"string"}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"headline":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkCaption":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}}},"required":[]}},"cursor":{"type":"string"}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"headline":{"type":"string"},"text":{"type":"string"},"advertisers":{"type":"array","items":{"type":"string"}},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"links":{"type":"array","items":{"type":"string","format":"uri"}},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachByCountry":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"countries":{"type":"array","items":{"type":"string"}},"ageRanges":{"type":"array","items":{"type":"string"}},"genders":{"type":"array","items":{"type":"string"}},"interests":{"type":"array","items":{"type":"string"}},"audienceTypes":{"type":"array","items":{"type":"string"}},"isCommercial":{"type":"boolean"}},"required":["adUrl","isCommercial"]}},"cursor":{"type":"string"}},"required":[]}]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/ads/ad":{"post":{"operationId":"adsAd","summary":"Get one ad's details from Meta, Google, TikTok, LinkedIn, Microsoft or Pinterest","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"ad":{"type":"string"},"network":{"type":"string","const":"meta"}},"required":["ad","network"],"additionalProperties":false},{"type":"object","properties":{"ad":{"type":"string"},"network":{"type":"string","const":"google"},"advertiser":{"type":"string"}},"required":["ad","network"],"additionalProperties":false},{"type":"object","properties":{"ad":{"type":"string"},"network":{"type":"string","const":"tiktok"}},"required":["ad","network"],"additionalProperties":false},{"type":"object","properties":{"ad":{"type":"string"},"network":{"type":"string","const":"linkedin"}},"required":["ad","network"],"additionalProperties":false},{"type":"object","properties":{"ad":{"type":"string","pattern":"^\\d{1,20}$"},"network":{"type":"string","const":"microsoft"}},"required":["ad","network"],"additionalProperties":false},{"type":"object","properties":{"ad":{"type":"string"},"network":{"type":"string","const":"pinterest"}},"required":["ad","network"],"additionalProperties":false}]}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserId":{"description":"Same as pageId. Present so this ad has the same keys as other ad networks.","type":"string"},"advertiserName":{"description":"Same as pageName. Present so this ad has the same keys as other ad networks.","type":"string"},"advertiserUrl":{"description":"Same as pageUrl. Present so this ad has the same keys as other ad networks.","type":"string","format":"uri"},"advertiserAvatarUrl":{"description":"Same as pageAvatarUrl. Present so this ad has the same keys as other ad networks.","type":"string","format":"uri"},"pageId":{"type":"string"},"pageName":{"type":"string"},"pageUrl":{"type":"string","format":"uri"},"pageAvatarUrl":{"type":"string","format":"uri"},"pageCategories":{"type":"array","items":{"type":"string"}},"pageLikes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isActive":{"type":"boolean"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"platforms":{"type":"array","items":{"type":"string"}},"format":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkTitle":{"type":"string"},"linkDescription":{"type":"string"},"ctaText":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"videoUrls":{"type":"array","items":{"type":"string","format":"uri"}},"cards":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkTitle":{"type":"string"},"ctaText":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"}},"required":[]}},"versions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"categories":{"type":"array","items":{"type":"string"}},"paidBy":{"type":"string"},"spendMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, e.g. USD."},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countries":{"type":"array","items":{"type":"string"}},"advertiserDescription":{"type":"string"},"advertiserCategory":{"type":"string"},"advertiserVerification":{"type":"string"},"advertiserInstagram":{"type":"string"},"advertiserInstagramFollowers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"audienceAgeGender":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"age":{"type":"string"},"female":{"type":"number"},"male":{"type":"number"},"unknown":{"type":"number"}},"required":["female","male","unknown"]}},"audienceRegions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"region":{"type":"string"},"share":{"type":"number"}},"required":["share"]}},"euReachTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"euReachByCountry":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"age":{"type":"string"},"female":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"male":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["female","male","unknown"]}},"payers":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"paidBy":{"type":"string"},"beneficiary":{"type":"string"}},"required":[]}}},"required":["adUrl","isActive","versions"]},{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"advertiserUrl":{"type":"string","format":"uri"},"domain":{"type":"string"},"format":{"type":"string","enum":["text","image","video","unknown"]},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"daysShown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previewUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"advertiserCountry":{"type":"string"},"advertiserIsVerified":{"type":"boolean"},"paidBy":{"type":"string"},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"variations":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"previewUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"}},"required":[]}},"regions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"targetingIncluded":{"type":"array","items":{"type":"string"}},"targetingExcluded":{"type":"array","items":{"type":"string"}}},"required":["adUrl","advertiserUrl","format"]},{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"advertiserName":{"type":"string"},"headline":{"type":"string"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"videoUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"advertiserId":{"type":"string"},"advertiserCountry":{"type":"string"},"paidBy":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"ctaText":{"type":"string"},"objective":{"type":"string"},"category":{"type":"string"},"audienceSizeMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"audienceSizeMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countries":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"interests":{"type":"string"},"regions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ages":{"type":"array","items":{"type":"string"}},"genders":{"type":"array","items":{"type":"string"}}},"required":[]}}},"required":["adUrl"]},{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"creativeType":{"type":"string"},"format":{"type":"string"},"advertiserName":{"type":"string"},"advertiserUrl":{"type":"string","format":"uri"},"advertiserAvatarUrl":{"type":"string","format":"uri"},"postedBy":{"type":"string"},"text":{"type":"string"},"headline":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"paidBy":{"type":"string"},"ctaText":{"type":"string"},"videoUrls":{"type":"array","items":{"type":"string","format":"uri"}},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countries":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"share":{"type":"number"}},"required":[]}},"targeting":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"parameter":{"type":"string"},"description":{"type":"string"}},"required":[]}},"targetingUsed":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"parameter":{"type":"string"},"isTargeted":{"type":"boolean"},"isExcluded":{"type":"boolean"}},"required":["isTargeted","isExcluded"]}}},"required":["adUrl"]},{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"headline":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"linkCaption":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string","format":"uri"}},"paidBy":{"type":"string"},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"impressionsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressionsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countries":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"share":{"type":"number"}},"required":[]}},"targeting":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"isExcluded":{"type":"boolean"}},"required":["isExcluded"]}}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"adId":{"type":"string"},"adUrl":{"type":"string","format":"uri"},"headline":{"type":"string"},"text":{"type":"string"},"advertisers":{"type":"array","items":{"type":"string"}},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"links":{"type":"array","items":{"type":"string","format":"uri"}},"firstShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastShownAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachByCountry":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"country":{"type":"string"},"reachMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":[]}},"countries":{"type":"array","items":{"type":"string"}},"ageRanges":{"type":"array","items":{"type":"string"}},"genders":{"type":"array","items":{"type":"string"}},"interests":{"type":"array","items":{"type":"string"}},"audienceTypes":{"type":"array","items":{"type":"string"}},"isCommercial":{"type":"boolean"}},"required":["adUrl","isCommercial"]}]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/ads/advertisers":{"post":{"operationId":"adsAdvertisers","summary":"Find advertisers by name in the Google or Microsoft ad library","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"network":{"type":"string","const":"google"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Country code like de. Advertisers are matched on ads shown in this country, wherever the advertiser is based. Any case is accepted."}},"required":["query","network"],"additionalProperties":false},{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200},"network":{"type":"string","const":"microsoft"}},"required":["query","network"],"additionalProperties":false}]},"example":{"query":"nike","network":"google"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"domains":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"advertiserCountry":{"type":"string"},"advertiserUrl":{"type":"string","format":"uri"},"isVerified":{"type":"boolean"},"adsMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"adsMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["advertiserUrl","isVerified"]}}},"required":[]},{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"advertiserId":{"type":"string"},"advertiserName":{"type":"string"},"advertiserCountry":{"type":"string"},"isVerified":{"type":"boolean"}},"required":["isVerified"]}}},"required":[]}]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}},"/v1/ai/answer":{"post":{"operationId":"aiAnswer","summary":"Ask an AI assistant a question and get its answer with the sources it cites","description":"Costs 1 credit per call.","x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"The question to ask, worded the way a buyer would ask an AI assistant, e.g. What is the best CRM for a small business? Up to 2000 characters."},"engine":{"default":"gemini","description":"Which AI assistant answers: gemini or chatgpt.","type":"string","enum":["gemini","chatgpt"]}},"required":["prompt"],"additionalProperties":false},"example":{"prompt":"What is the best CRM for a small business?"}}}},"responses":{"200":{"description":"The data, and the credits this call used.","headers":{"X-Request-ID":{"$ref":"#/components/headers/RequestId"},"x-credits-used":{"$ref":"#/components/headers/CreditsUsed"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"x-cache":{"$ref":"#/components/headers/Cache"},"x-cache-age":{"$ref":"#/components/headers/CacheAge"}},"content":{"application/json":{"schema":{"type":"object","required":["success","data","creditsUsed","requestId"],"properties":{"success":{"const":true},"data":{"type":"object","additionalProperties":false,"properties":{"engine":{"type":"string","enum":["gemini","chatgpt"]},"prompt":{"type":"string"},"answer":{"type":"string","minLength":1},"sources":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string"},"domain":{"type":"string","minLength":1}},"required":["url","domain"]}}},"required":["engine","answer","sources"]},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}}}}}}