{ "openapi": "3.1.0", "info": { "title": "apinoa", "version": "1.0.0", "summary": "Marketplace, social and image-translation data through one API.", "description": "Every response is `{ success, data, requestId }`; every error `{ success: false, error: { code, message } }`. Marketplaces return one commerce schema, social platforms one social schema. Docs: https://apinoa.com/docs", "contact": { "name": "apinoa", "url": "https://apinoa.com" }, "termsOfService": "https://apinoa.com/terms" }, "servers": [ { "url": "https://gateway.apinoa.com" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "AliExpress", "description": "AliExpress data in the shared commerce schema (Product, SearchResult, ReviewPage…)." }, { "name": "Amazon", "description": "Amazon data in the shared commerce schema (Product, SearchResult, ReviewPage…)." }, { "name": "Instagram", "description": "Instagram data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "LinkedIn", "description": "LinkedIn data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "Reddit", "description": "Reddit data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "Shopify", "description": "Shopify data in the shared commerce schema (Product, SearchResult, ReviewPage…)." }, { "name": "Threads", "description": "Threads data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "TikTok", "description": "TikTok data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "TikTok Shop", "description": "TikTok Shop data in the shared commerce schema (Product, SearchResult, ReviewPage…)." }, { "name": "Walmart", "description": "Walmart data in the shared commerce schema (Product, SearchResult, ReviewPage…)." }, { "name": "X", "description": "X data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "YouTube", "description": "YouTube data in the shared social schema (Account, Post, Comment, Group)." }, { "name": "Catalog", "description": "What the API serves, discoverable at runtime." }, { "name": "Image translate", "description": "Translate or read the text inside a product image." } ], "paths": { "/v1/aliexpress/search": { "get": { "operationId": "aliexpressSearch", "tags": [ "AliExpress" ], "x-fern-sdk-group-name": "aliexpress", "x-fern-sdk-method-name": "search", "summary": "AliExpress search", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/aliexpress/search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": false, "description": "AliExpress category id; narrows the search.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "description": "Presentment currency.", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "description": "Presentment language.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "1-based page number.", "schema": { "minimum": 1, "type": "integer" } }, { "name": "pageSize", "in": "query", "required": false, "description": "Results per page, 1-50.", "schema": { "minimum": 1, "type": "integer" } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "minimum": 0, "type": "number" } }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "minimum": 0, "type": "number" } }, { "name": "query", "in": "query", "required": true, "description": "Keywords. Required — AliExpress keyword search cannot be asked anything without words.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country (ISO 3166-1 alpha-2); sets shipping and availability.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Result ordering, in the shared vocabulary.", "schema": { "enum": [ "price_asc", "price_desc", "best_seller" ], "type": "string" } } ] } }, "/v1/aliexpress/browse": { "get": { "operationId": "aliexpressBrowse", "tags": [ "AliExpress" ], "x-fern-sdk-group-name": "aliexpress", "x-fern-sdk-method-name": "browse", "summary": "AliExpress browse", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/aliexpress/browse", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": true, "description": "AliExpress category id to list. Required — this is what is being browsed.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "description": "Presentment currency.", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "description": "Presentment language.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "1-based page number.", "schema": { "minimum": 1, "type": "integer" } }, { "name": "pageSize", "in": "query", "required": false, "description": "Results per page, 1-50.", "schema": { "minimum": 1, "type": "integer" } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "minimum": 0, "type": "number" } }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "minimum": 0, "type": "number" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country (ISO 3166-1 alpha-2); sets shipping and availability.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Result ordering, in the shared vocabulary.", "schema": { "enum": [ "price_asc", "price_desc", "best_seller" ], "type": "string" } } ] } }, "/v1/aliexpress/categories": { "get": { "operationId": "aliexpressCategories", "tags": [ "AliExpress" ], "x-fern-sdk-group-name": "aliexpress", "x-fern-sdk-method-name": "categories", "summary": "AliExpress categories", "description": "Returns `CategoryList` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/aliexpress/categories", "responses": { "200": { "description": "`CategoryList`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryListResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": false, "description": "Parent category id. Omit for the top-level categories.", "schema": { "type": "string" } } ] } }, "/v1/aliexpress/image-search": { "post": { "operationId": "aliexpressImageSearch", "tags": [ "AliExpress" ], "x-fern-sdk-group-name": "aliexpress", "x-fern-sdk-method-name": "imageSearch", "summary": "AliExpress image-search", "description": "Returns `SearchResult` in `data`. Costs 1 unit. POST only, with a JSON body. Reference: https://apinoa.com/docs/api-reference/aliexpress/image-search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "currency": { "description": "Presentment currency.", "type": "string" }, "image": { "description": "{contentType, data} with base64-encoded image bytes.", "type": "object" }, "language": { "description": "Presentment language.", "type": "string" }, "region": { "description": "Buyer country (ISO 3166-1 alpha-2).", "type": "string" } }, "required": [ "image" ], "type": "object" } } } } } }, "/v1/aliexpress/product": { "get": { "operationId": "aliexpressProduct", "tags": [ "AliExpress" ], "x-fern-sdk-group-name": "aliexpress", "x-fern-sdk-method-name": "product", "summary": "AliExpress product", "description": "Returns `Product` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/aliexpress/product", "responses": { "200": { "description": "`Product`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "currency", "in": "query", "required": false, "description": "Presentment currency.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "description": "AliExpress product id, as carried by a search item.", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "description": "include=shipping adds `delivery`: the cheapest shipping cost and delivery days to `region` for the product's listed variant. Costs one more unit.", "schema": { "enum": [ "shipping" ], "type": "string" } }, { "name": "language", "in": "query", "required": false, "description": "Presentment language.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country (ISO 3166-1 alpha-2).", "schema": { "type": "string" } } ] } }, "/v1/aliexpress/shipping": { "get": { "operationId": "aliexpressShipping", "tags": [ "AliExpress" ], "x-fern-sdk-group-name": "aliexpress", "x-fern-sdk-method-name": "shipping", "summary": "AliExpress shipping", "description": "Returns `ShippingQuote` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/aliexpress/shipping", "responses": { "200": { "description": "`ShippingQuote`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingQuoteResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "currency", "in": "query", "required": false, "description": "Currency for the shipping fee. Default USD.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "description": "AliExpress product id.", "schema": { "type": "string" } }, { "name": "quantity", "in": "query", "required": false, "description": "How many units are shipped together. Default 1.", "schema": { "minimum": 1, "type": "integer" } }, { "name": "region", "in": "query", "required": false, "description": "Destination country (ISO 3166-1 alpha-2). Default US.", "schema": { "type": "string" } }, { "name": "sku", "in": "query", "required": false, "description": "The variant to quote: a variant `id` from the product, or a numeric sku id. Omit for the product's listed variant.", "schema": { "type": "string" } } ] } }, "/v1/amazon/search": { "get": { "operationId": "amazonSearch", "tags": [ "Amazon" ], "x-fern-sdk-group-name": "amazon", "x-fern-sdk-method-name": "search", "summary": "Amazon search", "description": "Returns `SearchResult` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/amazon/search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Keywords to search for. Required here; to search by picture use `image-search`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "required": false, "description": "1-based page number; each page is charged separately. There is no `pageSize` (Amazon fixes the count per page by keyword, 13-47 in practice) and no `cursor` — paging is by number.", "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "region", "in": "query", "required": false, "description": "Which Amazon marketplace to query, by buyer country: US, CA, MX, BR, FR, IT, ES, NL, SE, TR, AE, SA, IN, JP, SG, AU. Defaults to US. Prices come back in that marketplace's own currency (JP in JPY, FR in EUR).", "schema": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "FR", "IT", "ES", "NL", "SE", "TR", "AE", "SA", "IN", "JP", "SG", "AU" ] } }, { "name": "categoryId", "in": "query", "required": false, "description": "Narrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's `facets`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "brands", "in": "query", "required": false, "description": "Brand names as Amazon spells them, e.g. brands=Nike,Adidas. A call that uses `brands` costs 2 units instead of 1. Not available on amazon.fr (`region=FR`).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "facets", "in": "query", "required": false, "description": "Narrowings taken from a result's `facets`, e.g. facets=Color:Black. A call that uses `facets` costs 2 units instead of 1. Not available on amazon.fr (`region=FR`).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "description": "Expansions that cost more than the default answer, e.g. include=facets.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "ratingMin", "in": "query", "required": false, "description": "`4` only. Amazon's rating filter offers exactly one threshold, \"4 Stars & Up\"; any other value is a 400 rather than a silently different search. Not available on amazon.fr (`region=FR`).", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "Result ordering: `best_match`, `price_asc`, `price_desc`, `newly_listed` or `avg_review`. Defaults to `best_match`, Amazon's own relevance ordering.", "schema": { "type": "string", "enum": [ "best_match", "price_asc", "price_desc", "newly_listed", "avg_review" ] } } ] } }, "/v1/amazon/image-search": { "post": { "operationId": "amazonImageSearch", "tags": [ "Amazon" ], "x-fern-sdk-group-name": "amazon", "x-fern-sdk-method-name": "imageSearch", "summary": "Amazon image-search", "description": "Returns `SearchResult` in `data`. Costs 1 unit, up to 2 units. POST only, with a JSON body. Reference: https://apinoa.com/docs/api-reference/amazon/image-search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "image": { "type": "object", "properties": { "contentType": { "type": "string", "pattern": "^image\\/(jpeg|jpg|png|gif)$", "description": "`image/jpeg`, `image/png` or `image/gif`. WebP and HEIC are not read by Amazon's visual search and are refused rather than answered with an empty result." }, "data": { "type": "string", "minLength": 1, "maxLength": 6000000, "description": "Base64-encoded image bytes, up to ~6 MB of base64." } }, "required": [ "contentType", "data" ], "additionalProperties": false, "description": "The picture to search by: `{contentType, data}` with `data` base64-encoded. POST only — a base64 image is tens of kilobytes and a URL caps out around 8 KB." }, "query": { "type": "string", "minLength": 1, "description": "Optional words that narrow the visual matches, e.g. the product type. Supplying it is usually much more precise." }, "page": { "type": "integer", "exclusiveMinimum": 0, "description": "1-based page number over the visual matches, about 48 per page; each page is charged separately. No `pageSize` and no `cursor`." }, "region": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "FR", "IT", "ES", "NL", "SE", "TR", "AE", "SA", "IN", "JP", "SG", "AU" ], "description": "Which Amazon marketplace to query, by buyer country: US, CA, MX, BR, FR, IT, ES, NL, SE, TR, AE, SA, IN, JP, SG, AU. Defaults to US. Prices come back in that marketplace's own currency (JP in JPY, FR in EUR)." }, "categoryId": { "type": "string", "minLength": 1, "description": "Narrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's `facets`." }, "priceMin": { "type": "number", "minimum": 0, "description": "Lowest price to return, in decimal major units." }, "priceMax": { "type": "number", "minimum": 0, "description": "Highest price to return, in decimal major units." }, "ratingMin": { "type": "number", "description": "`4` only. Amazon's rating filter offers exactly one threshold, \"4 Stars & Up\"; any other value is a 400 rather than a silently different search. Not available on amazon.fr (`region=FR`)." }, "sort": { "type": "string", "enum": [ "best_match", "price_asc", "price_desc", "newly_listed", "avg_review" ], "description": "Result ordering: `best_match`, `price_asc`, `price_desc`, `newly_listed` or `avg_review`. Defaults to `best_match`, Amazon's own relevance ordering." } }, "required": [ "image" ], "additionalProperties": false } } } } } }, "/v1/amazon/browse": { "get": { "operationId": "amazonBrowse", "tags": [ "Amazon" ], "x-fern-sdk-group-name": "amazon", "x-fern-sdk-method-name": "browse", "summary": "Amazon browse", "description": "Returns `SearchResult` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/amazon/browse", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": true, "description": "REQUIRED. An Amazon browse NODE — the digits from a category URL, e.g. `172541`. The department slugs `categories` returns at its root (`electronics`) are NOT browse nodes and are refused with `CATEGORY_NOT_BROWSABLE`: call `categories` with the slug to get its child nodes and browse one of those.", "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "required": false, "description": "1-based page number; each page is charged separately. There is no `pageSize` (Amazon fixes the count per page, 13-47 in practice) and no `cursor` — paging is by number.", "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "region", "in": "query", "required": false, "description": "Which Amazon marketplace to query, by buyer country: US, CA, MX, BR, FR, IT, ES, NL, SE, TR, AE, SA, IN, JP, SG, AU. Defaults to US. Prices come back in that marketplace's own currency (JP in JPY, FR in EUR).", "schema": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "FR", "IT", "ES", "NL", "SE", "TR", "AE", "SA", "IN", "JP", "SG", "AU" ] } }, { "name": "brands", "in": "query", "required": false, "description": "Brand names as Amazon spells them, e.g. brands=Nike,Adidas. A call that uses `brands` costs 2 units instead of 1. Not available on amazon.fr (`region=FR`).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "facets", "in": "query", "required": false, "description": "Narrowings taken from a result's `facets`, e.g. facets=Color:Black. A call that uses `facets` costs 2 units instead of 1. Not available on amazon.fr (`region=FR`).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "ratingMin", "in": "query", "required": false, "description": "`4` only. Amazon's rating filter offers exactly one threshold, \"4 Stars & Up\"; any other value is a 400 rather than a silently different search. Not available on amazon.fr (`region=FR`).", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "Result ordering: `best_match`, `price_asc`, `price_desc`, `newly_listed` or `avg_review`. Defaults to `best_match`, Amazon's own relevance ordering.", "schema": { "type": "string", "enum": [ "best_match", "price_asc", "price_desc", "newly_listed", "avg_review" ] } } ] } }, "/v1/amazon/categories": { "get": { "operationId": "amazonCategories", "tags": [ "Amazon" ], "x-fern-sdk-group-name": "amazon", "x-fern-sdk-method-name": "categories", "summary": "Amazon categories", "description": "Returns `CategoryList` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/amazon/categories", "responses": { "200": { "description": "`CategoryList`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryListResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": false, "description": "Omit for the 40 departments; give a browse node (`172541`) or a department slug (`electronics`) to list that category's children. This is the one endpoint that takes either kind of id.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Which Amazon marketplace to query, by buyer country: US, CA, MX, BR, FR, IT, ES, NL, SE, TR, AE, SA, IN, JP, SG, AU. Defaults to US. Prices come back in that marketplace's own currency (JP in JPY, FR in EUR).", "schema": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "FR", "IT", "ES", "NL", "SE", "TR", "AE", "SA", "IN", "JP", "SG", "AU" ] } } ] } }, "/v1/amazon/product": { "get": { "operationId": "amazonProduct", "tags": [ "Amazon" ], "x-fern-sdk-group-name": "amazon", "x-fern-sdk-method-name": "product", "summary": "Amazon product", "description": "Returns `Product` in `data`. Costs 2 units, up to 32 units. Reference: https://apinoa.com/docs/api-reference/amazon/product", "responses": { "200": { "description": "`Product`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "The marketplace's own product id, as carried by a search item.", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "`offers` · `offers:5` · `offers:all` — the enumerated competing-seller offers, which are fetched separately and so opt-in. Depth counts pages of offers (10 offers each) and each page is charged; `all` walks to the end, capped at 30 pages.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Which Amazon marketplace to query, by buyer country: US, CA, MX, BR, FR, IT, ES, NL, SE, TR, AE, SA, IN, JP, SG, AU. Defaults to US. Prices come back in that marketplace's own currency (JP in JPY, FR in EUR).", "schema": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "FR", "IT", "ES", "NL", "SE", "TR", "AE", "SA", "IN", "JP", "SG", "AU" ] } } ] } }, "/v1/instagram/profile": { "get": { "operationId": "instagramProfile", "tags": [ "Instagram" ], "x-fern-sdk-group-name": "instagram", "x-fern-sdk-method-name": "profile", "summary": "Instagram profile", "description": "Returns `Account` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/instagram/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "Attach from the same page, at no extra cost: posts (the creator's latest posts, ext.posts).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ] } }, "/v1/instagram/post": { "get": { "operationId": "instagramPost", "tags": [ "Instagram" ], "x-fern-sdk-group-name": "instagram", "x-fern-sdk-method-name": "post", "summary": "Instagram post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/instagram/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Post shortcode, or the post URL (…/p//, …/reel//, …/tv//).", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "Attach from the same page, at no extra cost: comments (the first comments, ext.comments), authorPosts (the author's other recent posts, ext.authorPosts).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ] } }, "/v1/instagram/posts": { "get": { "operationId": "instagramPosts", "tags": [ "Instagram" ], "x-fern-sdk-group-name": "instagram", "x-fern-sdk-method-name": "posts", "summary": "Instagram posts", "description": "Returns `PostPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/instagram/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "username: the creator's posts (default) or reels.", "schema": { "type": "string", "enum": [ "posts", "reels" ] } }, { "name": "hashtag", "in": "query", "required": false, "description": "Top posts under a hashtag: with or without #, or its page URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "location", "in": "query", "required": false, "description": "Posts at a location: numeric location id or URL (…/explore/locations//). One page: Instagram shows the rest only to signed-in users.", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/instagram/comments": { "get": { "operationId": "instagramComments", "tags": [ "Instagram" ], "x-fern-sdk-group-name": "instagram", "x-fern-sdk-method-name": "comments", "summary": "Instagram comments", "description": "Returns `CommentPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/instagram/comments", "responses": { "200": { "description": "`CommentPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "The post's comments: shortcode or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "sort", "in": "query", "required": false, "description": "recent (newest first) — the only order Instagram serves logged-out visitors.", "schema": { "type": "string", "enum": [ "recent" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/instagram/group": { "get": { "operationId": "instagramGroup", "tags": [ "Instagram" ], "x-fern-sdk-group-name": "instagram", "x-fern-sdk-method-name": "group", "summary": "Instagram group", "description": "Returns `Group` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/instagram/group", "responses": { "200": { "description": "`Group`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "hashtag", "in": "query", "required": false, "description": "A hashtag: with or without #, or its page URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "location", "in": "query", "required": false, "description": "A location: numeric id or URL (…/explore/locations//).", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "Attach from the same page, at no extra cost: posts (the tag's top posts / the location's posts, ext.posts).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ] } }, "/v1/instagram/groups": { "get": { "operationId": "instagramGroups", "tags": [ "Instagram" ], "x-fern-sdk-group-name": "instagram", "x-fern-sdk-method-name": "groups", "summary": "Instagram groups", "description": "Returns `GroupPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/instagram/groups", "responses": { "200": { "description": "`GroupPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "highlights (a creator's highlight reels).", "schema": { "type": "string", "enum": [ "highlights" ] } } ] } }, "/v1/linkedin/profile": { "get": { "operationId": "linkedinProfile", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "profile", "summary": "LinkedIn profile", "description": "Returns `Account` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Person vanity handle (with or without in/, e.g. williamhgates), or the profile URL.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/linkedin/post": { "get": { "operationId": "linkedinPost", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "post", "summary": "LinkedIn post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Activity id, urn:li:activity:, or the post URL.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/linkedin/posts": { "get": { "operationId": "linkedinPosts", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "posts", "summary": "LinkedIn posts", "description": "Returns `PostPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Person vanity handle (with or without in/, e.g. williamhgates), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "company", "in": "query", "required": false, "description": "Company vanity name (with or without company/, e.g. microsoft), or the company URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Most posts to return (LinkedIn shows the most recent few).", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ] } }, "/v1/linkedin/comments": { "get": { "operationId": "linkedinComments", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "comments", "summary": "LinkedIn comments", "description": "Returns `CommentPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/comments", "responses": { "200": { "description": "`CommentPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "The post's comments: activity id, urn:li:activity:, or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Most comments to return (LinkedIn shows a post's top few).", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ] } }, "/v1/linkedin/group": { "get": { "operationId": "linkedinGroup", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "group", "summary": "LinkedIn group", "description": "Returns `Group` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/group", "responses": { "200": { "description": "`Group`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "company", "in": "query", "required": false, "description": "Company vanity name (with or without company/, e.g. microsoft), or the company URL.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/linkedin/job": { "get": { "operationId": "linkedinJob", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "job", "summary": "LinkedIn job", "description": "Returns `Job` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/job", "responses": { "200": { "description": "`Job`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Numeric job id, urn:li:jobPosting:, or the job URL.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/linkedin/jobs": { "get": { "operationId": "linkedinJobs", "tags": [ "LinkedIn" ], "x-fern-sdk-group-name": "linkedin", "x-fern-sdk-method-name": "jobs", "summary": "LinkedIn jobs", "description": "Returns `JobPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/linkedin/jobs", "responses": { "200": { "description": "`JobPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": false, "description": "Job search keywords (e.g. software engineer).", "schema": { "type": "string", "minLength": 1 } }, { "name": "location", "in": "query", "required": false, "description": "Location name (e.g. United States). Default: worldwide.", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/reddit/profile": { "get": { "operationId": "redditProfile", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "profile", "summary": "Reddit profile", "description": "Returns `Account` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/reddit/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Username, with or without u/, or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "Extra reads to attach under `ext`: trophies (+1 unit).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ] } }, "/v1/reddit/profiles": { "get": { "operationId": "redditProfiles", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "profiles", "summary": "Reddit profiles", "description": "Returns `AccountPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/reddit/profiles", "responses": { "200": { "description": "`AccountPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": false, "description": "Keywords to search accounts for.", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/reddit/post": { "get": { "operationId": "redditPost", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "post", "summary": "Reddit post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/reddit/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Post id (base36), fullname (t3_…), or the post URL (reddit.com, old.reddit.com, redd.it).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/reddit/posts": { "get": { "operationId": "redditPosts", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "posts", "summary": "Reddit posts", "description": "Returns `PostPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/reddit/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "A user's posts: username (with or without u/) or profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "community", "in": "query", "required": false, "description": "A community's posts: name (with or without r/) or URL. With `query`, narrows the search to it.", "schema": { "type": "string", "minLength": 1 } }, { "name": "query", "in": "query", "required": false, "description": "Search posts by keyword.", "schema": { "type": "string", "minLength": 1 } }, { "name": "ids", "in": "query", "required": false, "description": "Specific posts: ids, fullnames (t3_…) or URLs, 1–100 in one call.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "sort", "in": "query", "required": false, "description": "Order. username: new, hot, top, controversial · community: hot, new, top, rising, controversial · query: relevance, hot, top, new, comments · default feed: hot, new, top, rising.", "schema": { "type": "string", "enum": [ "hot", "new", "top", "rising", "controversial", "relevance", "comments" ] } }, { "name": "period", "in": "query", "required": false, "description": "Time window for sort top or controversial: hour, day, week, month, year or all.", "schema": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ] } }, { "name": "country", "in": "query", "required": false, "description": "Default feed only: the country whose popular feed to read (ISO alpha-2).", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/reddit/comments": { "get": { "operationId": "redditComments", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "comments", "summary": "Reddit comments", "description": "Returns `CommentPage` in `data`. Costs 1 unit, up to 3 units. Reference: https://apinoa.com/docs/api-reference/reddit/comments", "responses": { "200": { "description": "`CommentPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "A post's comments: post id, fullname (t3_…) or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "comment", "in": "query", "required": false, "description": "With `post`: the comment whose replies to load (base36 id or t1_ fullname) — e.g. one whose `moreReplies` says replies were held back.", "schema": { "type": "string", "minLength": 1 } }, { "name": "username", "in": "query", "required": false, "description": "A user's comments: username or profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "sort", "in": "query", "required": false, "description": "Order. post: confidence (Reddit's 'best'), top, new, controversial, old, qa · username: new, hot, top, controversial.", "schema": { "type": "string", "enum": [ "confidence", "top", "new", "controversial", "old", "qa", "hot" ] } }, { "name": "period", "in": "query", "required": false, "description": "Time window for sort top or controversial: hour, day, week, month, year or all.", "schema": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/reddit/group": { "get": { "operationId": "redditGroup", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "group", "summary": "Reddit group", "description": "Returns `Group` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/reddit/group", "responses": { "200": { "description": "`Group`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "community", "in": "query", "required": false, "description": "Community name (with or without r/) or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "Extra reads to attach under `ext`: rules (+1 unit). The community's style is always in `ext.style` (it comes with the community), so `style` is accepted and free.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ] } }, "/v1/reddit/groups": { "get": { "operationId": "redditGroups", "tags": [ "Reddit" ], "x-fern-sdk-group-name": "reddit", "x-fern-sdk-method-name": "groups", "summary": "Reddit groups", "description": "Returns `GroupPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/reddit/groups", "responses": { "200": { "description": "`GroupPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": false, "description": "Search communities by keyword.", "schema": { "type": "string", "minLength": 1 } }, { "name": "prefix", "in": "query", "required": false, "description": "Autocomplete: communities whose name starts with this (fast, one page).", "schema": { "type": "string", "minLength": 1 } }, { "name": "username", "in": "query", "required": false, "description": "The communities a user is active in: username or profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "includeNsfw", "in": "query", "required": false, "description": "prefix only: include over-18 communities.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/shopify/search": { "get": { "operationId": "shopifySearch", "tags": [ "Shopify" ], "x-fern-sdk-group-name": "shopify", "x-fern-sdk-method-name": "search", "summary": "Shopify search", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/shopify/search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Keywords to search for. Required: Shopify search always needs a keyword, which is also why Shopify has no keyword-less `browse`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque; comes from the previous response and carries the page index. Shopify pages by cursor rather than by number — this is the only paging knob, and `page` is refused by name.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "required": false, "description": "Narrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's `facets`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "ratingMin", "in": "query", "required": false, "description": "Lowest average star rating to return, on the marketplace's own 0-5 scale.", "schema": { "type": "number", "minimum": 0, "maximum": 5 } }, { "name": "condition", "in": "query", "required": false, "description": "Item condition: `new` or `used`. `refurbished` is refused by name rather than folded into `used` — the catalog sells new and secondhand, and those are different claims.", "schema": { "type": "string", "enum": [ "new", "used" ] } }, { "name": "inStock", "in": "query", "required": false, "description": "Only listings the marketplace reports as purchasable now.", "schema": { "type": "boolean" } } ] } }, "/v1/shopify/image-search": { "post": { "operationId": "shopifyImageSearch", "tags": [ "Shopify" ], "x-fern-sdk-group-name": "shopify", "x-fern-sdk-method-name": "imageSearch", "summary": "Shopify image-search", "description": "Returns `SearchResult` in `data`. Costs 1 unit. POST only, with a JSON body. Reference: https://apinoa.com/docs/api-reference/shopify/image-search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "image": { "type": "object", "properties": { "contentType": { "type": "string", "pattern": "^image\\/(jpeg|png|webp|gif|avif)$" }, "data": { "type": "string", "minLength": 1, "maxLength": 6000000 } }, "required": [ "contentType", "data" ], "additionalProperties": false, "description": "Base64 image input for visual search; the image is the anchor and `query` narrows it — the reverse of `search`. Up to ~6MB of base64; supported types are jpeg, png, webp, gif and avif." }, "query": { "type": "string", "minLength": 1, "description": "Optional text that refines the image — the reverse of `search`, where the query anchors the result. For example, a sneaker photo with `query=wool` returns wool sneakers rather than any sneaker of that shape." }, "cursor": { "type": "string", "description": "Opaque; comes from the previous response and carries the page index. Shopify pages by cursor rather than by number — this is the only paging knob, and `page` is refused by name." }, "region": { "type": "string", "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price." }, "categoryId": { "type": "string", "minLength": 1, "description": "Narrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's `facets`." }, "priceMin": { "type": "number", "minimum": 0, "description": "Lowest price to return, in decimal major units." }, "priceMax": { "type": "number", "minimum": 0, "description": "Highest price to return, in decimal major units." }, "ratingMin": { "type": "number", "minimum": 0, "maximum": 5, "description": "Lowest average star rating to return, on the marketplace's own 0-5 scale." }, "condition": { "type": "string", "enum": [ "new", "used" ], "description": "Item condition: `new` or `used`. `refurbished` is refused by name rather than folded into `used` — the catalog sells new and secondhand, and those are different claims." }, "inStock": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false", "1", "0" ] } ], "description": "Only listings the marketplace reports as purchasable now." } }, "required": [ "image" ], "additionalProperties": false } } } } } }, "/v1/shopify/catalog": { "get": { "operationId": "shopifyCatalog", "tags": [ "Shopify" ], "x-fern-sdk-group-name": "shopify", "x-fern-sdk-method-name": "catalog", "summary": "Shopify catalog", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/shopify/catalog", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "The store: its host (comfrt.com) or any URL on it — a product, collection or home page link.", "schema": { "type": "string", "minLength": 3 } }, { "name": "collection", "in": "query", "required": false, "description": "Only this collection: its handle (best-sellers) or its URL. Omitted means the whole store — unless `id` is itself a collection page link, which lists that collection.", "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "required": false, "description": "1-based page number.", "schema": { "type": "integer", "minimum": 1 } }, { "name": "pageSize", "in": "query", "required": false, "description": "Products per page, 1–250 (default 50).", "schema": { "type": "integer", "minimum": 1, "maximum": 250 } }, { "name": "cursor", "in": "query", "required": false, "description": "The previous page's `cursor`. Pass it for the next page; it also carries the store's total forward.", "schema": { "type": "string", "pattern": "^\\d{1,5}(\\.\\d{1,7})?$" } }, { "name": "currency", "in": "query", "required": false, "description": "Presentment currency, ISO 4217.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/shopify/product": { "get": { "operationId": "shopifyProduct", "tags": [ "Shopify" ], "x-fern-sdk-group-name": "shopify", "x-fern-sdk-method-name": "product", "summary": "Shopify product", "description": "Returns `Product` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/shopify/product", "responses": { "200": { "description": "`Product`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "A Shopify id rather than a global identifier: the composite `shop/handle`, e.g. us.giesswein.com/wool-sneaker-women. A search item's `id` is already in this form, and a full product URL is accepted too.", "schema": { "type": "string", "minLength": 3 } }, { "name": "currency", "in": "query", "required": false, "description": "Presentment currency, ISO 4217.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/shopify/reviews": { "get": { "operationId": "shopifyReviews", "tags": [ "Shopify" ], "x-fern-sdk-group-name": "shopify", "x-fern-sdk-method-name": "reviews", "summary": "Shopify reviews", "description": "Returns `ReviewPage` in `data`. Costs 1 unit, up to 7 units. Reference: https://apinoa.com/docs/api-reference/shopify/reviews", "responses": { "200": { "description": "`ReviewPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "The composite Shopify `shop/handle` — the same id `product` takes, not a global identifier. This is the one Shopify operation whose cost varies: a first page can cost more than 1, while a page fetched with `cursor` costs 1.", "schema": { "type": "string", "minLength": 3 } }, { "name": "page", "in": "query", "required": false, "description": "1-based starting page. Not every shop supports jumping to a page number; `cursor` works on every shop, so prefer it for paging.", "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous response; the only paging knob that works on every shop, and it wins if `page` is sent too. A page fetched with a cursor costs 1.", "schema": { "type": "string" } } ] } }, "/v1/threads/profile": { "get": { "operationId": "threadsProfile", "tags": [ "Threads" ], "x-fern-sdk-group-name": "threads", "x-fern-sdk-method-name": "profile", "summary": "Threads profile", "description": "Returns `Account` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/threads/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Numeric Threads user id.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/threads/post": { "get": { "operationId": "threadsPost", "tags": [ "Threads" ], "x-fern-sdk-group-name": "threads", "x-fern-sdk-method-name": "post", "summary": "Threads post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/threads/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Post shortcode, or the post URL (…/@user/post/ or …/t/).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/threads/posts": { "get": { "operationId": "threadsPosts", "tags": [ "Threads" ], "x-fern-sdk-group-name": "threads", "x-fern-sdk-method-name": "posts", "summary": "Threads posts", "description": "Returns `PostPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/threads/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "username: the creator's threads (default), reposts or replies.", "schema": { "type": "string", "enum": [ "posts", "reposts", "replies" ] } }, { "name": "query", "in": "query", "required": false, "description": "Search posts by keyword (one page).", "schema": { "type": "string", "minLength": 1 } }, { "name": "hashtag", "in": "query", "required": false, "description": "Posts for a topic tag, with or without # (one page). Threads often answers a tag as a keyword match over post text and topic names; the page's `ext.matchedBy` says `tag` or `keyword`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "sort", "in": "query", "required": false, "description": "query only: top (default) or recent.", "schema": { "type": "string", "enum": [ "top", "recent" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/threads/comments": { "get": { "operationId": "threadsComments", "tags": [ "Threads" ], "x-fern-sdk-group-name": "threads", "x-fern-sdk-method-name": "comments", "summary": "Threads comments", "description": "Returns `CommentPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/threads/comments", "responses": { "200": { "description": "`CommentPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "The post's replies: shortcode or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "sort", "in": "query", "required": false, "description": "top (default) or recent.", "schema": { "type": "string", "enum": [ "top", "recent" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/profile": { "get": { "operationId": "tiktokProfile", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "profile", "summary": "TikTok profile", "description": "Returns `Account` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktok/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/profiles": { "get": { "operationId": "tiktokProfiles", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "profiles", "summary": "TikTok profiles", "description": "Returns `AccountPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/tiktok/profiles", "responses": { "200": { "description": "`AccountPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Creator secUid. Pass it instead of a username to save the lookup (1 unit instead of 2).", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "Which list: followers or following.", "schema": { "type": "string", "enum": [ "followers", "following" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–30.", "schema": { "type": "integer", "minimum": 1, "maximum": 30 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/post": { "get": { "operationId": "tiktokPost", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "post", "summary": "TikTok post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktok/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Numeric video id, or the video URL / share link (vm.tiktok.com/…).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/posts": { "get": { "operationId": "tiktokPosts", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "posts", "summary": "TikTok posts", "description": "Returns `PostPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/tiktok/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Creator secUid. Pass it instead of a username to save the lookup (1 unit instead of 2).", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "username/userId: the creator's posts (default), reposts or likes.", "schema": { "type": "string", "enum": [ "posts", "reposts", "likes" ] } }, { "name": "hashtag", "in": "query", "required": false, "description": "Videos under a hashtag: its name, or its numeric id (saves the lookup). A hashtag that is itself a number takes its # (#2024).", "schema": { "type": "string", "minLength": 1 } }, { "name": "sound", "in": "query", "required": false, "description": "Videos using a sound: sound id or URL (…/music/-).", "schema": { "type": "string", "minLength": 1 } }, { "name": "playlist", "in": "query", "required": false, "description": "Videos in a playlist: id or URL (…/playlist/-).", "schema": { "type": "string", "minLength": 1 } }, { "name": "category", "in": "query", "required": false, "description": "Default feed only: explore category id (default 120).", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–30.", "schema": { "type": "integer", "minimum": 1, "maximum": 30 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/comments": { "get": { "operationId": "tiktokComments", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "comments", "summary": "TikTok comments", "description": "Returns `CommentPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktok/comments", "responses": { "200": { "description": "`CommentPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "The video's comments: numeric video id or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "comment", "in": "query", "required": false, "description": "With `post`: the comment whose replies to load (its id).", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–50.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/group": { "get": { "operationId": "tiktokGroup", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "group", "summary": "TikTok group", "description": "Returns `Group` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktok/group", "responses": { "200": { "description": "`Group`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "hashtag", "in": "query", "required": false, "description": "A hashtag: its name, or its numeric id. A hashtag that is itself a number takes its # (#2024).", "schema": { "type": "string", "minLength": 1 } }, { "name": "sound", "in": "query", "required": false, "description": "A sound: id or URL (…/music/-).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/groups": { "get": { "operationId": "tiktokGroups", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "groups", "summary": "TikTok groups", "description": "Returns `GroupPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/tiktok/groups", "responses": { "200": { "description": "`GroupPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Creator @handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Creator secUid. Pass it instead of a username to save the lookup (1 unit instead of 2).", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "playlists (the only list TikTok has).", "schema": { "type": "string", "enum": [ "playlists" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–30.", "schema": { "type": "integer", "minimum": 1, "maximum": 30 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/tiktok/media": { "get": { "operationId": "tiktokMedia", "tags": [ "TikTok" ], "x-fern-sdk-group-name": "tiktok", "x-fern-sdk-method-name": "media", "summary": "TikTok media", "description": "Returns `MediaFile` in `data`. Costs 2 units. Reference: https://apinoa.com/docs/api-reference/tiktok/media", "responses": { "200": { "description": "`MediaFile`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "The post whose file to download: numeric id or URL. A video gives its MP4, a photo post one picture.", "schema": { "type": "string", "minLength": 1 } }, { "name": "index", "in": "query", "required": false, "description": "Photo posts: which picture, 1-based (default 1).", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ] } }, "/v1/tiktokshop/search": { "get": { "operationId": "tiktokshopSearch", "tags": [ "TikTok Shop" ], "x-fern-sdk-group-name": "tiktokshop", "x-fern-sdk-method-name": "search", "summary": "TikTok Shop search", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktokshop/search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Keywords to search for.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/tiktokshop/browse": { "get": { "operationId": "tiktokshopBrowse", "tags": [ "TikTok Shop" ], "x-fern-sdk-group-name": "tiktokshop", "x-fern-sdk-method-name": "browse", "summary": "TikTok Shop browse", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktokshop/browse", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": true, "description": "REQUIRED. The category to list, by the marketplace's own id.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/tiktokshop/categories": { "get": { "operationId": "tiktokshopCategories", "tags": [ "TikTok Shop" ], "x-fern-sdk-group-name": "tiktokshop", "x-fern-sdk-method-name": "categories", "summary": "TikTok Shop categories", "description": "Returns `CategoryList` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktokshop/categories", "responses": { "200": { "description": "`CategoryList`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryListResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": false, "description": "Omit for the root departments; give a category id to list its children.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/tiktokshop/catalog": { "get": { "operationId": "tiktokshopCatalog", "tags": [ "TikTok Shop" ], "x-fern-sdk-group-name": "tiktokshop", "x-fern-sdk-method-name": "catalog", "summary": "TikTok Shop catalog", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktokshop/catalog", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "The store, by the marketplace's own id (on Shopify: its host or any URL on it).", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "The previous page's `cursor`, for the next 30 products.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/tiktokshop/product": { "get": { "operationId": "tiktokshopProduct", "tags": [ "TikTok Shop" ], "x-fern-sdk-group-name": "tiktokshop", "x-fern-sdk-method-name": "product", "summary": "TikTok Shop product", "description": "Returns `Product` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktokshop/product", "responses": { "200": { "description": "`Product`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "The marketplace's own product id, as carried by a search item.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/tiktokshop/reviews": { "get": { "operationId": "tiktokshopReviews", "tags": [ "TikTok Shop" ], "x-fern-sdk-group-name": "tiktokshop", "x-fern-sdk-method-name": "reviews", "summary": "TikTok Shop reviews", "description": "Returns `ReviewPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/tiktokshop/reviews", "responses": { "200": { "description": "`ReviewPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "The product whose reviews to return.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/walmart/search": { "get": { "operationId": "walmartSearch", "tags": [ "Walmart" ], "x-fern-sdk-group-name": "walmart", "x-fern-sdk-method-name": "search", "summary": "Walmart search", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/walmart/search", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Keywords to search for. Required: image search is not available on Walmart, so a keyword query is the only way to search.", "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "required": false, "description": "1-based results page. There is no `pageSize` — the results page is server-fixed at about 50 organic items — and no `cursor`, since paging here is by number.", "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "required": false, "description": "Narrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's `facets`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "brands", "in": "query", "required": false, "description": "Brand names as the marketplace spells them, e.g. brands=Nike,Adidas.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "ratingMin", "in": "query", "required": false, "description": "Lowest average star rating to return, on the marketplace's own 0-5 scale.", "schema": { "type": "number", "minimum": 0, "maximum": 5 } }, { "name": "facets", "in": "query", "required": false, "description": "Narrowings taken from a result's `facets`, e.g. facets=Color:Black. The escape hatch for filters the typed vocabulary has no word for; prefer a typed parameter where one exists.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "sort", "in": "query", "required": false, "description": "Result ordering: `best_match`, `price_asc`, `price_desc`, `newly_listed` or `best_seller`. Defaults to `best_match`, Walmart's own relevance ordering.", "schema": { "type": "string", "enum": [ "best_match", "price_asc", "price_desc", "newly_listed", "best_seller" ] } } ] } }, "/v1/walmart/browse": { "get": { "operationId": "walmartBrowse", "tags": [ "Walmart" ], "x-fern-sdk-group-name": "walmart", "x-fern-sdk-method-name": "browse", "summary": "Walmart browse", "description": "Returns `SearchResult` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/walmart/browse", "responses": { "200": { "description": "`SearchResult`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": true, "description": "REQUIRED. The underscore-joined chain from a Walmart category URL, e.g. 3944_133251_1095191_1230614_1230478. A bare department or leaf id is refused with CATEGORY_NOT_BROWSABLE — use `categories` to walk down to a chain.", "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "required": false, "description": "1-based results page. There is no `pageSize` — the results page is server-fixed at about 50 organic items — and no `cursor`, since paging here is by number.", "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } }, { "name": "priceMin", "in": "query", "required": false, "description": "Lowest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "priceMax", "in": "query", "required": false, "description": "Highest price to return, in decimal major units.", "schema": { "type": "number", "minimum": 0 } }, { "name": "brands", "in": "query", "required": false, "description": "Brand names as the marketplace spells them, e.g. brands=Nike,Adidas.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "ratingMin", "in": "query", "required": false, "description": "Lowest average star rating to return, on the marketplace's own 0-5 scale.", "schema": { "type": "number", "minimum": 0, "maximum": 5 } }, { "name": "facets", "in": "query", "required": false, "description": "Narrowings taken from a result's `facets`, e.g. facets=Color:Black. The escape hatch for filters the typed vocabulary has no word for; prefer a typed parameter where one exists.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "sort", "in": "query", "required": false, "description": "Result ordering: `best_match`, `price_asc`, `price_desc`, `newly_listed` or `best_seller`. Defaults to `best_match`, Walmart's own relevance ordering.", "schema": { "type": "string", "enum": [ "best_match", "price_asc", "price_desc", "newly_listed", "best_seller" ] } } ] } }, "/v1/walmart/categories": { "get": { "operationId": "walmartCategories", "tags": [ "Walmart" ], "x-fern-sdk-group-name": "walmart", "x-fern-sdk-method-name": "categories", "summary": "Walmart categories", "description": "Returns `CategoryList` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/walmart/categories", "responses": { "200": { "description": "`CategoryList`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryListResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "categoryId", "in": "query", "required": false, "description": "Omit for the 42 departments; give a bare department id (`4171`) or an underscore chain to list that category's children. Unlike `browse`, a bare id is accepted here — descending from one is how a client reaches the chains `browse` takes.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/walmart/product": { "get": { "operationId": "walmartProduct", "tags": [ "Walmart" ], "x-fern-sdk-group-name": "walmart", "x-fern-sdk-method-name": "product", "summary": "Walmart product", "description": "Returns `Product` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/walmart/product", "responses": { "200": { "description": "`Product`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "Walmart's `usItemId`, all digits, as carried by a search item — chain straight in.", "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "description": "Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.", "schema": { "type": "string" } } ] } }, "/v1/walmart/reviews": { "get": { "operationId": "walmartReviews", "tags": [ "Walmart" ], "x-fern-sdk-group-name": "walmart", "x-fern-sdk-method-name": "reviews", "summary": "Walmart reviews", "description": "Returns `ReviewPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/walmart/reviews", "responses": { "200": { "description": "`ReviewPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "Walmart's `usItemId`, all digits, as carried by a search item.", "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "required": false, "description": "1-based review page; Walmart returns 10 reviews per page.", "schema": { "type": "integer", "exclusiveMinimum": 0 } } ] } }, "/v1/x/profile": { "get": { "operationId": "xProfile", "tags": [ "X" ], "x-fern-sdk-group-name": "x", "x-fern-sdk-method-name": "profile", "summary": "X profile", "description": "Returns `Account` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/x/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "@handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/x/post": { "get": { "operationId": "xPost", "tags": [ "X" ], "x-fern-sdk-group-name": "x", "x-fern-sdk-method-name": "post", "summary": "X post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/x/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Numeric post id, or the post URL (x.com//status/).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/x/posts": { "get": { "operationId": "xPosts", "tags": [ "X" ], "x-fern-sdk-group-name": "x", "x-fern-sdk-method-name": "posts", "summary": "X posts", "description": "Returns `PostPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/x/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "@handle (with or without @), or the profile URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Numeric user id. Pass it instead of a username to save the lookup.", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1–100 — a hint only: X decides the page size (about 20, or ~100 for the most-liked list).", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/x/group": { "get": { "operationId": "xGroup", "tags": [ "X" ], "x-fern-sdk-group-name": "x", "x-fern-sdk-method-name": "group", "summary": "X group", "description": "Returns `Group` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/x/group", "responses": { "200": { "description": "`Group`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "community", "in": "query", "required": false, "description": "Numeric community id, or the community URL (x.com/i/communities/).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/youtube/profile": { "get": { "operationId": "youtubeProfile", "tags": [ "YouTube" ], "x-fern-sdk-group-name": "youtube", "x-fern-sdk-method-name": "profile", "summary": "YouTube profile", "description": "Returns `Account` in `data`. Costs 1 unit, up to 3 units. Reference: https://apinoa.com/docs/api-reference/youtube/profile", "responses": { "200": { "description": "`Account`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Channel @handle (with or without @), or the channel URL (/@handle, /channel/UC…, /c/…, /user/…).", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Channel id (UC…).", "schema": { "type": "string", "minLength": 1 } }, { "name": "include", "in": "query", "required": false, "description": "about: also read the channel's About panel — join date (createdAt), exact video count, total views, country and every link (+1 unit).", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ] } }, "/v1/youtube/profiles": { "get": { "operationId": "youtubeProfiles", "tags": [ "YouTube" ], "x-fern-sdk-group-name": "youtube", "x-fern-sdk-method-name": "profiles", "summary": "YouTube profiles", "description": "Returns `AccountPage` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/youtube/profiles", "responses": { "200": { "description": "`AccountPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "query", "in": "query", "required": false, "description": "Search channels by keyword.", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/youtube/post": { "get": { "operationId": "youtubePost", "tags": [ "YouTube" ], "x-fern-sdk-group-name": "youtube", "x-fern-sdk-method-name": "post", "summary": "YouTube post", "description": "Returns `Post` in `data`. Costs 1 unit. Reference: https://apinoa.com/docs/api-reference/youtube/post", "responses": { "200": { "description": "`Post`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Video id (11 chars), or the video URL (watch?v=…, youtu.be/…, /shorts/…).", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/youtube/posts": { "get": { "operationId": "youtubePosts", "tags": [ "YouTube" ], "x-fern-sdk-group-name": "youtube", "x-fern-sdk-method-name": "posts", "summary": "YouTube posts", "description": "Returns `PostPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/youtube/posts", "responses": { "200": { "description": "`PostPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Channel @handle (with or without @), or the channel URL (/@handle, /channel/UC…, /c/…, /user/…).", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Channel id (UC…).", "schema": { "type": "string", "minLength": 1 } }, { "name": "query", "in": "query", "required": false, "description": "Search videos by keyword.", "schema": { "type": "string", "minLength": 1 } }, { "name": "hashtag", "in": "query", "required": false, "description": "Videos under a hashtag, with or without #.", "schema": { "type": "string", "minLength": 1 } }, { "name": "relatedTo", "in": "query", "required": false, "description": "A video id or URL; returns the videos YouTube recommends beside it.", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "username/userId: which channel tab — videos (default), shorts, live or community · query: videos (default) or shorts.", "schema": { "type": "string", "enum": [ "videos", "shorts", "live", "community" ] } }, { "name": "country", "in": "query", "required": false, "description": "Default feed only: the country whose trending feed to read (ISO alpha-2, default US).", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/youtube/comments": { "get": { "operationId": "youtubeComments", "tags": [ "YouTube" ], "x-fern-sdk-group-name": "youtube", "x-fern-sdk-method-name": "comments", "summary": "YouTube comments", "description": "Returns `CommentPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/youtube/comments", "responses": { "200": { "description": "`CommentPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "post", "in": "query", "required": false, "description": "The video's comments: video id or URL.", "schema": { "type": "string", "minLength": 1 } }, { "name": "comment", "in": "query", "required": false, "description": "A comment's replies: the comment's `moreReplies.cursor`.", "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/youtube/groups": { "get": { "operationId": "youtubeGroups", "tags": [ "YouTube" ], "x-fern-sdk-group-name": "youtube", "x-fern-sdk-method-name": "groups", "summary": "YouTube groups", "description": "Returns `GroupPage` in `data`. Costs 1 unit, up to 2 units. Reference: https://apinoa.com/docs/api-reference/youtube/groups", "responses": { "200": { "description": "`GroupPage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPageResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } }, "parameters": [ { "name": "username", "in": "query", "required": false, "description": "Channel @handle (with or without @), or the channel URL (/@handle, /channel/UC…, /c/…, /user/…).", "schema": { "type": "string", "minLength": 1 } }, { "name": "userId", "in": "query", "required": false, "description": "Channel id (UC…).", "schema": { "type": "string", "minLength": 1 } }, { "name": "type", "in": "query", "required": false, "description": "playlists (a channel's playlists).", "schema": { "type": "string", "enum": [ "playlists" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from the previous page's `cursor`. Pass it alone for the next page.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/v1/marketplaces": { "get": { "operationId": "listMarketplaces", "x-fern-sdk-group-name": "marketplaces", "x-fern-sdk-method-name": "list", "tags": [ "Catalog" ], "summary": "List every platform, its operations and their inputs", "description": "Public: works without a key. Reference: https://apinoa.com/docs/api-reference/marketplaces", "security": [], "responses": { "200": { "description": "The catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponse" } } } }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/image-translate/translate": { "post": { "tags": [ "Image translate" ], "x-fern-sdk-group-name": "imageTranslate", "operationId": "imageTranslateTranslate", "x-fern-sdk-method-name": "translate", "summary": "Translate the text in an image", "description": "Replaces the text inside a product image with a translation, keeping weight, colours, layout and badge backdrops. Returns the translated JPEG, or with render=false the cleaned image and every text region as JSON. Most calls take 1.5–3 s; allow up to 300 s. Reference: https://apinoa.com/docs/api-reference/image-translate/translate", "parameters": [ { "name": "source_language", "in": "query", "required": true, "description": "The text's language: ch, zh, zh-CN, zh-TW, chinese_cht, ja, japan, en, or auto.", "schema": { "type": "string", "enum": [ "auto", "ch", "zh", "zh-CN", "zh-TW", "chinese_cht", "ja", "japan", "en" ] } }, { "name": "target_language", "in": "query", "required": true, "description": "The language to translate into (ISO 639-style code, e.g. ko, en, ja, zh-CN).", "schema": { "type": "string", "minLength": 2, "maxLength": 8 } }, { "name": "font", "in": "query", "required": false, "description": "A value from allFonts in supported-fonts, or user/ for an uploaded font. Default Pretendard.", "schema": { "type": "string" } }, { "name": "font_weight", "in": "query", "required": false, "description": "auto matches each region's original weight. Default ExtraBold.", "schema": { "type": "string", "enum": [ "auto", "Thin", "Light", "Regular", "Medium", "SemiBold", "Bold", "ExtraBold", "Black" ] } }, { "name": "render", "in": "query", "required": false, "description": "true (default) returns the finished image; false returns the regions as JSON.", "schema": { "type": "boolean" } } ], "requestBody": { "required": true, "description": "The image as raw bytes (not JSON, not base64). JPEG, PNG or WebP, up to 20 MB and 8192 × 8192 px.", "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "The translated JPEG (render=true), or the regions as JSON (render=false).", "headers": { "X-Apinoa-Regions-Count": { "description": "How many text regions were detected and replaced.", "schema": { "type": "integer" } } }, "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TranslatedRegionsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } } } }, "/v1/image-translate/ocr": { "post": { "tags": [ "Image translate" ], "x-fern-sdk-group-name": "imageTranslate", "operationId": "imageTranslateOcr", "x-fern-sdk-method-name": "ocr", "summary": "Read the text in an image", "description": "Detects every text region without translating. Reference: https://apinoa.com/docs/api-reference/image-translate/ocr", "parameters": [ { "name": "source_language", "in": "query", "required": true, "description": "The text's language: ch, zh, zh-CN, zh-TW, chinese_cht, ja, japan, en, or auto.", "schema": { "type": "string", "enum": [ "auto", "ch", "zh", "zh-CN", "zh-TW", "chinese_cht", "ja", "japan", "en" ] } } ], "requestBody": { "required": true, "description": "The image as raw bytes (not JSON, not base64). JPEG, PNG or WebP, up to 20 MB and 8192 × 8192 px.", "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "The regions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OcrResultResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } } } }, "/v1/image-translate/supported-fonts": { "get": { "tags": [ "Image translate" ], "x-fern-sdk-group-name": "imageTranslate", "operationId": "imageTranslateSupportedFonts", "x-fern-sdk-method-name": "supportedFonts", "summary": "List the fonts and languages", "description": "Reference: https://apinoa.com/docs/api-reference/image-translate/supported-fonts", "responses": { "200": { "description": "The fonts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedFontsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "501": { "$ref": "#/components/responses/Error501" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Create one under Dashboard > API keys." } }, "schemas": { "Account": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "id": { "type": "string" }, "handle": { "type": "string" }, "displayName": { "type": "string" }, "bio": { "type": "string" }, "url": { "type": "string" }, "avatarUrl": { "type": "string" }, "bannerUrl": { "type": "string" }, "verified": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "counts": { "type": "object", "properties": { "followers": { "type": "integer", "minimum": 0 }, "following": { "type": "integer", "minimum": 0 }, "posts": { "type": "integer", "minimum": 0 } } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "private": { "type": "boolean" }, "category": { "type": "string" }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "handle", "url" ] }, "AccountPage": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "cursor": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "items" ] }, "AccountPageResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/AccountPage" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "AccountRef": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "id": { "type": "string" }, "handle": { "type": "string" }, "displayName": { "type": "string" }, "url": { "type": "string" }, "avatarUrl": { "type": "string" }, "verified": { "type": "boolean" }, "counts": { "type": "object", "properties": { "followers": { "type": "integer", "minimum": 0 }, "following": { "type": "integer", "minimum": 0 }, "posts": { "type": "integer", "minimum": 0 } } }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform" ] }, "AccountResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Account" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Attribute": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] }, "Audio": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "artist": { "type": "string" }, "url": { "type": "string" } } }, "Broadcast": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "scheduled", "live", "ended" ] }, "scheduledAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time" }, "endedAt": { "type": "string", "format": "date-time" } }, "required": [ "status" ] }, "Catalog": { "type": "object", "required": [ "marketplaces" ], "properties": { "marketplaces": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "operations" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "marketplace", "sns" ] }, "operations": { "type": "array", "items": { "type": "string" } }, "regions": { "type": "array", "items": { "type": "string" } }, "cost": { "type": "object", "additionalProperties": { "type": "object", "properties": { "base": { "type": "integer" }, "max": { "type": "integer" } } } }, "params": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "description": "Each operation's input, as JSON Schema." } } } }, "pricing": { "type": "object", "additionalProperties": true } } }, "CatalogResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Catalog" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "CategoryList": { "type": "object", "properties": { "marketplace": { "type": "string" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryStep" }, "default": [] }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryNode" }, "default": [] } }, "required": [ "marketplace", "path", "categories" ] }, "CategoryListResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/CategoryList" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "CategoryNode": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "parentId": { "type": "string" }, "hasChildren": { "type": "boolean" }, "browsable": { "type": "boolean" }, "productCount": { "type": "integer", "minimum": 0 }, "ext": { "$ref": "#/components/schemas/Ext" } }, "required": [ "id", "name" ] }, "CategoryStep": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "Comment": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "id": { "type": "string" }, "url": { "type": "string" }, "postId": { "type": "string" }, "parentId": { "type": "string" }, "author": { "$ref": "#/components/schemas/AccountRef" }, "text": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "editedAt": { "type": "string", "format": "date-time" }, "lang": { "type": "string" }, "pinned": { "type": "boolean" }, "byAuthor": { "type": "boolean" }, "likedByAuthor": { "type": "boolean" }, "metrics": { "type": "object", "properties": { "likes": { "type": "integer", "minimum": 0 }, "replies": { "type": "integer", "minimum": 0 } } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/SocialMedia" } }, "replies": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "moreReplies": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 }, "ids": { "type": "array", "items": { "type": "string" } }, "cursor": { "type": "string" }, "ext": { "type": "object", "additionalProperties": {} } } }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "id", "postId", "author", "text", "replies" ] }, "CommentPage": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "cursor": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "items" ] }, "CommentPageResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/CommentPage" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "DeliveryOption": { "type": "object", "properties": { "carrier": { "type": "string" }, "code": { "type": "string" }, "estimate": { "type": "string" }, "cost": { "$ref": "#/components/schemas/Money" }, "free": { "type": "boolean" }, "minDays": { "type": "integer", "minimum": 0 }, "maxDays": { "type": "integer", "minimum": 0 }, "guaranteedDays": { "type": "integer", "minimum": 0 }, "handlingDays": { "type": "integer", "minimum": 0 }, "cutoff": { "type": "string" }, "condition": { "type": "string" }, "available": { "type": "boolean" }, "membership": { "type": "string" }, "minimumOrder": { "$ref": "#/components/schemas/Money" }, "tracking": { "type": "boolean" }, "shipsFrom": { "type": "string" } } }, "Entities": { "type": "object", "properties": { "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/Mention" } }, "urls": { "type": "array", "items": { "$ref": "#/components/schemas/Url" } }, "hashtags": { "type": "array", "items": { "type": "string" } } } }, "ErrorResponse": { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Stable within v1; branch on this, never on message. Listed at https://apinoa.com/docs/errors" }, "message": { "type": "string" } } }, "requestId": { "type": "string" } } }, "Ext": { "type": "object", "additionalProperties": {} }, "Facet": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "select", "range" ] }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/FacetValue" }, "default": [] }, "min": { "type": "number" }, "max": { "type": "number" }, "maps_to": { "type": "string" } }, "required": [ "id", "name", "kind", "values" ] }, "FacetValue": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "count": { "type": "integer", "minimum": 0 }, "selected": { "type": "boolean" } }, "required": [ "value", "name" ] }, "Group": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "kind": { "type": "string", "enum": [ "community", "channel", "company", "hashtag", "sound", "topic", "location", "list" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "avatarUrl": { "type": "string" }, "bannerUrl": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "counts": { "type": "object", "properties": { "members": { "type": "integer", "minimum": 0 }, "posts": { "type": "integer", "minimum": 0 } } }, "sensitive": { "type": "boolean" }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "kind", "id", "name", "url" ] }, "GroupPage": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } }, "cursor": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "items" ] }, "GroupPageResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/GroupPage" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "GroupResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Identifiers": { "type": "object", "properties": { "gtin": { "type": "string" }, "mpn": { "type": "string" }, "model": { "type": "string" } } }, "InReplyTo": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "author": { "$ref": "#/components/schemas/AccountRef" } }, "required": [ "id" ] }, "Job": { "type": "object", "properties": { "platform": { "type": "string", "const": "linkedin" }, "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string" }, "logoUrl": { "type": "string" } }, "required": [ "name" ] }, "location": { "type": "string" }, "postedText": { "type": "string" }, "applicants": { "type": "integer", "minimum": 0 }, "applicantsAtLeast": { "type": "integer", "minimum": 0 }, "seniority": { "type": "string" }, "employmentType": { "type": "string" }, "jobFunction": { "type": "string" }, "industries": { "type": "string" }, "description": { "type": "string" }, "descriptionHtml": { "type": "string" } }, "required": [ "platform", "id", "url", "title", "company" ] }, "JobPage": { "type": "object", "properties": { "platform": { "type": "string", "const": "linkedin" }, "items": { "type": "array", "items": { "type": "object", "properties": { "platform": { "type": "string", "const": "linkedin" }, "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name" ] }, "location": { "type": "string" }, "listedAt": { "type": "string", "format": "date-time" }, "logoUrl": { "type": "string" } }, "required": [ "platform", "id", "url", "title", "company" ] } }, "cursor": { "type": "string" } }, "required": [ "platform", "items" ] }, "JobPageResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/JobPage" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "JobResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Job" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Link": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" } }, "required": [ "url" ] }, "LinkPreview": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "thumbnailUrl": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "url" ] }, "Media": { "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" }, "default": [] }, "videos": { "type": "array", "items": { "$ref": "#/components/schemas/MediaVideo" }, "default": [] } }, "required": [ "images", "videos" ] }, "MediaFile": { "type": "object", "properties": { "platform": { "type": "string" }, "postId": { "type": "string" }, "contentType": { "type": "string", "description": "The file's MIME type, e.g. video/mp4 or image/jpeg." }, "bytes": { "type": "integer", "description": "The decoded file's size in bytes." }, "encoding": { "type": "string", "const": "base64" }, "data": { "type": "string", "description": "The file, base64-encoded." }, "index": { "type": "integer", "description": "Photo posts: which picture this is, 1-based." }, "count": { "type": "integer", "description": "Photo posts: how many pictures the post has." } }, "required": [ "platform", "postId", "contentType", "bytes", "encoding", "data" ] }, "MediaFileResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/MediaFile" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "MediaVariant": { "type": "object", "properties": { "url": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "bitrate": { "type": "integer" }, "contentType": { "type": "string" } }, "required": [ "url" ] }, "MediaVideo": { "type": "object", "properties": { "thumbnailUrl": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "duration": { "type": "string" }, "creator": { "type": "string" } } }, "Mention": { "type": "object", "properties": { "handle": { "type": "string" }, "id": { "type": "string" }, "displayName": { "type": "string" } }, "required": [ "handle" ] }, "Money": { "type": "object", "properties": { "currency": { "type": "string" }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] }, "OcrResult": { "type": "object", "required": [ "regions" ], "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/TextRegion" } }, "regions_found": { "type": "integer" }, "src_w": { "type": "integer" }, "src_h": { "type": "integer" } } }, "OcrResultResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/OcrResult" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Offer": { "type": "object", "properties": { "seller": { "$ref": "#/components/schemas/Seller" }, "price": { "$ref": "#/components/schemas/Money" }, "listPrice": { "$ref": "#/components/schemas/Money" }, "condition": { "type": "string" }, "conditionNote": { "type": "string" }, "fulfilledBy": { "type": "string" }, "inStock": { "type": "boolean" }, "status": { "type": "string" }, "delivery": { "$ref": "#/components/schemas/DeliveryOption" }, "ext": { "$ref": "#/components/schemas/Ext" } }, "required": [ "price" ] }, "Option": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/OptionValue" }, "default": [] } }, "required": [ "id", "name", "values" ] }, "OptionValue": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "imageUrl": { "type": "string" } }, "required": [ "id", "name" ] }, "Page": { "type": "object", "properties": { "index": { "type": "integer" }, "size": { "type": "integer" }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "index", "size" ] }, "Place": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "lat": { "type": "number" }, "lng": { "type": "number" }, "address": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" } }, "required": [ "name" ] }, "Poll": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "votes": { "type": "integer", "minimum": 0 } }, "required": [ "text" ] } }, "totalVotes": { "type": "integer", "minimum": 0 }, "endsAt": { "type": "string", "format": "date-time" } }, "required": [ "options" ] }, "Post": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "id": { "type": "string" }, "url": { "type": "string" }, "author": { "$ref": "#/components/schemas/AccountRef" }, "title": { "type": "string" }, "text": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "editedAt": { "type": "string", "format": "date-time" }, "lang": { "type": "string" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/SocialMedia" }, "default": [] }, "metrics": { "type": "object", "properties": { "likes": { "type": "integer", "minimum": 0 }, "comments": { "type": "integer", "minimum": 0 }, "shares": { "type": "integer", "minimum": 0 }, "views": { "type": "integer", "minimum": 0 }, "reposts": { "type": "integer", "minimum": 0 }, "quotes": { "type": "integer", "minimum": 0 }, "saves": { "type": "integer", "minimum": 0 }, "liveViewers": { "type": "integer", "minimum": 0 } } }, "entities": { "$ref": "#/components/schemas/Entities" }, "linkPreview": { "$ref": "#/components/schemas/LinkPreview" }, "poll": { "$ref": "#/components/schemas/Poll" }, "place": { "$ref": "#/components/schemas/Place" }, "audio": { "$ref": "#/components/schemas/Audio" }, "live": { "type": "boolean" }, "broadcast": { "$ref": "#/components/schemas/Broadcast" }, "repostOf": { "$ref": "#/components/schemas/Post" }, "quoteOf": { "$ref": "#/components/schemas/Post" }, "inReplyTo": { "$ref": "#/components/schemas/InReplyTo" }, "sponsored": { "type": "boolean" }, "pinned": { "type": "boolean" }, "aiGenerated": { "type": "boolean" }, "sensitive": { "type": "boolean" }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "id", "url", "author", "media" ] }, "PostPage": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "reddit", "linkedin", "tiktok", "youtube", "instagram", "threads", "x" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "cursor": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "platform", "items" ] }, "PostPageResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PostPage" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "PostResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Post" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Product": { "type": "object", "properties": { "marketplace": { "type": "string" }, "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "price": { "$ref": "#/components/schemas/Money" }, "listPrice": { "$ref": "#/components/schemas/Money" }, "condition": { "type": "string" }, "conditionNote": { "type": "string" }, "unitPrice": { "type": "object", "properties": { "price": { "$ref": "#/components/schemas/Money" }, "unit": { "type": "string" } }, "required": [ "price" ] }, "brand": { "type": "string" }, "rating": { "$ref": "#/components/schemas/Rating" }, "seller": { "$ref": "#/components/schemas/Seller" }, "salesCount": { "type": "integer", "minimum": 0 }, "salesLabel": { "type": "string" }, "inStock": { "type": "boolean" }, "status": { "type": "string" }, "delivery": { "$ref": "#/components/schemas/ShippingOption" }, "shippingOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "stock": { "type": "integer", "minimum": 0 }, "identifiers": { "$ref": "#/components/schemas/Identifiers" }, "listingFormat": { "type": "string" }, "paymentOptions": { "type": "array", "items": { "type": "string" } }, "returnsPolicy": { "type": "string" }, "badges": { "type": "array", "items": { "type": "string" }, "default": [] }, "promotions": { "type": "array", "items": { "type": "string" }, "default": [] }, "groupId": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" }, "default": [] }, "offersSummary": { "type": "object", "properties": { "count": { "type": "integer" }, "fromPrice": { "$ref": "#/components/schemas/Money" }, "url": { "type": "string" } } }, "priceRange": { "type": "object", "properties": { "min": { "$ref": "#/components/schemas/Money" }, "max": { "$ref": "#/components/schemas/Money" } }, "required": [ "min", "max" ] }, "endsAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2}))?$" }, "purchaseLimit": { "type": "integer", "exclusiveMinimum": 0 }, "listedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2}))?$" }, "deliveryTo": { "type": "object", "properties": { "label": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" } } }, "ext": { "$ref": "#/components/schemas/Ext" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "media": { "$ref": "#/components/schemas/Media" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryStep" }, "default": [] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Option" }, "default": [] }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/Variant" }, "default": [] }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" }, "default": [] }, "subscriptionPrice": { "$ref": "#/components/schemas/Money" }, "reviewSummary": { "type": "string" }, "reviewAspects": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "mentions": { "type": "integer" }, "positive": { "type": "integer" }, "negative": { "type": "integer" } }, "required": [ "name" ] }, "default": [] }, "boxContents": { "type": "array", "items": { "type": "string" }, "default": [] }, "brandUrl": { "type": "string" }, "fulfilledBy": { "type": "string" }, "replacedBy": { "type": "string" }, "reviews": { "type": "array", "items": { "$ref": "#/components/schemas/Review" }, "default": [] }, "package": { "type": "object", "properties": { "lengthCm": { "type": "number", "minimum": 0 }, "widthCm": { "type": "number", "minimum": 0 }, "heightCm": { "type": "number", "minimum": 0 }, "weightKg": { "type": "number", "minimum": 0 }, "soldInLot": { "type": "boolean" } } }, "wholesale": { "type": "boolean" }, "included": { "type": "array", "items": { "type": "string" } } }, "required": [ "marketplace", "id", "title", "media", "badges", "promotions", "attributes", "features", "category", "options", "variants", "offers", "reviewAspects", "boxContents", "reviews" ] }, "ProductResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Product" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Rating": { "type": "object", "properties": { "average": { "type": "number" }, "count": { "type": "integer", "minimum": 0 }, "distribution": { "type": "object", "additionalProperties": { "type": "number" } }, "grouped": { "type": "boolean" } }, "required": [ "average" ] }, "Review": { "type": "object", "properties": { "id": { "type": "string" }, "author": { "type": "string" }, "rating": { "type": "number" }, "title": { "type": "string" }, "body": { "type": "string" }, "date": { "type": "string" }, "country": { "type": "string" }, "verified": { "type": "boolean" }, "helpfulCount": { "type": "integer" }, "variant": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" }, "default": [] }, "incentivized": { "type": "boolean" }, "reply": { "type": "object", "properties": { "body": { "type": "string" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2}))?$" }, "author": { "type": "string" } }, "required": [ "body" ] }, "ext": { "$ref": "#/components/schemas/Ext" } }, "required": [ "rating", "images" ] }, "ReviewPage": { "type": "object", "properties": { "marketplace": { "type": "string" }, "productId": { "type": "string" }, "summary": { "$ref": "#/components/schemas/Rating" }, "page": { "$ref": "#/components/schemas/Page" }, "reviews": { "type": "array", "items": { "$ref": "#/components/schemas/Review" }, "default": [] }, "cursor": { "type": "string" }, "grouped": { "type": "boolean" }, "ext": { "$ref": "#/components/schemas/Ext" } }, "required": [ "marketplace", "productId", "page", "reviews" ] }, "ReviewPageResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ReviewPage" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "SearchItem": { "type": "object", "properties": { "marketplace": { "type": "string" }, "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "price": { "$ref": "#/components/schemas/Money" }, "listPrice": { "$ref": "#/components/schemas/Money" }, "condition": { "type": "string" }, "conditionNote": { "type": "string" }, "unitPrice": { "type": "object", "properties": { "price": { "$ref": "#/components/schemas/Money" }, "unit": { "type": "string" } }, "required": [ "price" ] }, "brand": { "type": "string" }, "rating": { "$ref": "#/components/schemas/Rating" }, "seller": { "$ref": "#/components/schemas/Seller" }, "salesCount": { "type": "integer", "minimum": 0 }, "salesLabel": { "type": "string" }, "inStock": { "type": "boolean" }, "status": { "type": "string" }, "delivery": { "$ref": "#/components/schemas/ShippingOption" }, "shippingOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "stock": { "type": "integer", "minimum": 0 }, "identifiers": { "$ref": "#/components/schemas/Identifiers" }, "listingFormat": { "type": "string" }, "paymentOptions": { "type": "array", "items": { "type": "string" } }, "returnsPolicy": { "type": "string" }, "badges": { "type": "array", "items": { "type": "string" }, "default": [] }, "promotions": { "type": "array", "items": { "type": "string" }, "default": [] }, "groupId": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" }, "default": [] }, "offersSummary": { "type": "object", "properties": { "count": { "type": "integer" }, "fromPrice": { "$ref": "#/components/schemas/Money" }, "url": { "type": "string" } } }, "priceRange": { "type": "object", "properties": { "min": { "$ref": "#/components/schemas/Money" }, "max": { "$ref": "#/components/schemas/Money" } }, "required": [ "min", "max" ] }, "endsAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2}))?$" }, "purchaseLimit": { "type": "integer", "exclusiveMinimum": 0 }, "listedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2}))?$" }, "deliveryTo": { "type": "object", "properties": { "label": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" } } }, "ext": { "$ref": "#/components/schemas/Ext" }, "imageUrl": { "type": "string" }, "sponsored": { "type": "boolean" }, "variantCount": { "type": "integer", "exclusiveMinimum": 0 }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryStep" } }, "matchScore": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "marketplace", "id", "title", "badges", "promotions", "attributes" ] }, "SearchResult": { "type": "object", "properties": { "marketplace": { "type": "string" }, "query": { "type": "string" }, "page": { "$ref": "#/components/schemas/Page" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SearchItem" }, "default": [] }, "cursor": { "type": "string" }, "facets": { "type": "array", "items": { "$ref": "#/components/schemas/Facet" } } }, "required": [ "marketplace", "page", "items" ] }, "SearchResultResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/SearchResult" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Seller": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "rating": { "$ref": "#/components/schemas/Rating" }, "country": { "type": "string" }, "detailedRatings": { "type": "object", "properties": { "itemAsDescribed": { "type": "number" }, "communication": { "type": "number" }, "shippingSpeed": { "type": "number" } } }, "positivePercent": { "type": "number", "minimum": 0, "maximum": 100 }, "ext": { "$ref": "#/components/schemas/Ext" } } }, "ShippingOption": { "type": "object", "properties": { "carrier": { "type": "string" }, "code": { "type": "string" }, "estimate": { "type": "string" }, "cost": { "$ref": "#/components/schemas/Money" }, "free": { "type": "boolean" }, "minDays": { "type": "integer", "minimum": 0 }, "maxDays": { "type": "integer", "minimum": 0 }, "guaranteedDays": { "type": "integer", "minimum": 0 }, "handlingDays": { "type": "integer", "minimum": 0 }, "cutoff": { "type": "string" }, "condition": { "type": "string" }, "available": { "type": "boolean" }, "membership": { "type": "string" }, "minimumOrder": { "$ref": "#/components/schemas/Money" }, "tracking": { "type": "boolean" }, "shipsFrom": { "type": "string" } } }, "ShippingQuote": { "type": "object", "properties": { "marketplace": { "type": "string" }, "productId": { "type": "string" }, "skuId": { "type": "string" }, "region": { "type": "string" }, "quantity": { "type": "integer", "exclusiveMinimum": 0 }, "available": { "type": "boolean" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingOption" }, "default": [] } }, "required": [ "marketplace", "productId", "region", "quantity", "available", "options" ] }, "ShippingQuoteResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ShippingQuote" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "SocialMedia": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image", "gif", "video", "embed" ] }, "url": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "thumbnailUrl": { "type": "string" }, "durationSec": { "type": "number" }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/MediaVariant" } }, "altText": { "type": "string" }, "caption": { "type": "string" }, "ext": { "type": "object", "additionalProperties": {} } }, "required": [ "type", "url" ] }, "SupportedFonts": { "type": "object", "properties": { "fontsByLanguage": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "defaultByLanguage": { "type": "object", "additionalProperties": { "type": "string" } }, "allFonts": { "type": "array", "items": { "type": "string" } }, "allWeights": { "type": "array", "items": { "type": "string" } }, "supportedSourceLanguages": { "type": "array", "items": { "type": "string" } }, "userFonts": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "SupportedFontsResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/SupportedFonts" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "TextRegion": { "type": "object", "required": [ "index", "polygon", "bbox", "text" ], "properties": { "index": { "type": "integer", "description": "The region's number, starting at 0." }, "polygon": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "description": "Four corner points, in the original image's coordinates." }, "bbox": { "type": "object", "required": [ "x", "y", "w", "h" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" } } }, "text": { "type": "string", "description": "The text that was read." }, "confidence": { "type": "number", "description": "Recognition confidence, 0–1." }, "text_color": { "type": "object", "required": [ "r", "g", "b" ], "properties": { "r": { "type": "integer" }, "g": { "type": "integer" }, "b": { "type": "integer" } } }, "bg_color": { "type": "object", "required": [ "r", "g", "b" ], "properties": { "r": { "type": "integer" }, "g": { "type": "integer" }, "b": { "type": "integer" } } }, "bg_std": { "type": "number", "description": "How uneven the background is behind the text; near 0 is a flat colour." }, "font_weight": { "type": "string" }, "is_badge": { "type": "boolean", "description": "True for text on a filled label, such as a price tag." } } }, "TranslatedRegion": { "type": "object", "required": [ "index", "polygon", "bbox", "text" ], "properties": { "index": { "type": "integer", "description": "The region's number, starting at 0." }, "polygon": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "description": "Four corner points, in the original image's coordinates." }, "bbox": { "type": "object", "required": [ "x", "y", "w", "h" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" } } }, "text": { "type": "string", "description": "The text that was read." }, "confidence": { "type": "number", "description": "Recognition confidence, 0–1." }, "text_color": { "type": "object", "required": [ "r", "g", "b" ], "properties": { "r": { "type": "integer" }, "g": { "type": "integer" }, "b": { "type": "integer" } } }, "bg_color": { "type": "object", "required": [ "r", "g", "b" ], "properties": { "r": { "type": "integer" }, "g": { "type": "integer" }, "b": { "type": "integer" } } }, "bg_std": { "type": "number", "description": "How uneven the background is behind the text; near 0 is a flat colour." }, "font_weight": { "type": "string" }, "is_badge": { "type": "boolean", "description": "True for text on a filled label, such as a price tag." }, "text_kr": { "type": "string", "description": "The translation, in target_language (the field name is historical)." } } }, "TranslatedRegions": { "type": "object", "required": [ "inpainted_base64", "regions" ], "properties": { "inpainted_base64": { "type": "string", "description": "The image with the source text removed, as a base64 JPEG." }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/TranslatedRegion" } }, "regions_count": { "type": "integer" } } }, "TranslatedRegionsResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/TranslatedRegions" }, "requestId": { "type": "string", "description": "Quote it if you contact support. Also sent as the x-request-id header." } } }, "Url": { "type": "object", "properties": { "url": { "type": "string" }, "displayUrl": { "type": "string" } }, "required": [ "url" ] }, "Variant": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string" }, "sku": { "type": "string" }, "price": { "$ref": "#/components/schemas/Money" }, "listPrice": { "$ref": "#/components/schemas/Money" }, "bulkPrice": { "$ref": "#/components/schemas/Money" }, "purchaseLimit": { "type": "integer", "exclusiveMinimum": 0 }, "taxIncluded": { "type": "boolean" }, "inStock": { "type": "boolean" }, "stock": { "type": "integer", "minimum": 0 }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/VariantSelection" }, "default": [] }, "identifiers": { "$ref": "#/components/schemas/Identifiers" }, "weightKg": { "type": "number", "minimum": 0 }, "ext": { "$ref": "#/components/schemas/Ext" } }, "required": [ "id", "selections" ] }, "VariantSelection": { "type": "object", "properties": { "optionId": { "type": "string" }, "valueId": { "type": "string" }, "optionName": { "type": "string" }, "valueName": { "type": "string" } }, "required": [ "optionId", "valueId", "optionName", "valueName" ] } }, "responses": { "Error400": { "description": "The request is invalid: a parameter is missing, unknown or out of range. Never billed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error401": { "description": "The x-api-key header is missing, or the key is invalid or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error402": { "description": "The balance does not cover the call. Retrying does not clear it: top up.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error403": { "description": "The account is suspended, or this call is not allowed for the key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error404": { "description": "No such platform, operation, or thing (product, account, post…).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error429": { "description": "Too many requests, or no capacity right now. Wait the Retry-After seconds and retry.", "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error500": { "description": "A fault on our side. Retry, and quote the requestId if it persists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error501": { "description": "The data exists but could not be read for this input.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error502": { "description": "The platform did not answer usably. Retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Error503": { "description": "Temporarily unavailable. Retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }