API Reference

Synchronous Client

API Reference for Synchronous Jungle Scout API.

class junglescout.client_sync.ClientSync(api_key_name, api_key, api_type=ApiType.JS, marketplace=None)[source]

The Jungle Scout Synchronous API client.

This class is used to make synchronous requests to the Jungle Scout API.

close()[source]

Closes all connections used by the client.

Return type:

None

historical_search_volume(keyword, start_date, end_date, sort_option=None, marketplace=None)[source]

Retrieves the historical search volume for a given keyword within a specified date range.

Parameters:

  • keyword (str) – The keyword for which to retrieve the historical search volume.

  • start_date (str) – The start date of the date range in the format ‘YYYY-MM-DD’.

  • end_date (str) – The end date of the date range in the format ‘YYYY-MM-DD’.

  • sort_option (Optional[Sort]) – The sort option for the search volume data. Must use the Sort enum.

  • marketplace (Optional[Marketplace]) – The marketplace for which to retrieve the search volume data. If not provided, the default marketplace will be used.

Return type:

APIResponse[List[HistoricalSearchVolume]]

Returns:

The response from the API.

Raises:

Exception – If the request to retrieve the historical search volume fails.

property is_closed: bool

Boolean indicating if the client session is closed.

keywords_by_asin(asin, include_variants=True, filter_options=None, sort_option=None, marketplace=None, page_size=None, page=None)[source]

Get keywords by ASIN.

Parameters:

  • asin (Union[str, List[str]]) – The ASIN (Amazon Standard Identification Number) of the product. This can be a list of ASINs or a single ASIN.

  • include_variants (bool) – Include variants in the response.

  • filter_options (Optional[FilterOptions]) – Filter options for the request.

  • sort_option (Optional[Sort]) – Sort option for the request.

  • marketplace (Optional[Marketplace]) – The Amazon marketplace.

  • page_size (Optional[int]) – The number of results to return per page.

  • page (Optional[str]) – The page to return.

Return type:

APIResponse[List[KeywordByASIN]]

Returns:

The response from the API.

keywords_by_keyword(search_terms, categories=None, filter_options=None, sort_option=None, marketplace=None, page_size=None, page=None)[source]

Retrieves keyword data based on the provided search terms.

Parameters:

  • search_terms (str) – The search terms to retrieve keyword data for.

  • categories (Optional[List[str]]) – A list of category names to filter the results by. Must be valid inside the categories of the selected Marketplace.

  • filter_options (Optional[FilterOptions]) – The filter options to apply to the results.

  • sort_option (Optional[Sort]) – The sort option to apply to the results.

  • marketplace (Optional[Marketplace]) – The marketplace to retrieve keyword data from. If not provided, the marketplace provided at the client level will be used.

  • page_size (Optional[int]) – The number of results to retrieve per page.

  • page (Optional[str]) – The page token to retrieve a specific page of results. Used in pagination

Return type:

APIResponse[List[KeywordByKeyword]]

Returns:

The response from the API.

Raises:

Exception – If the request to retrieve keyword data fails.

product_database(include_keywords=None, exclude_keywords=None, collapse_by_parent=None, categories=None, product_tiers=None, seller_types=None, product_filter_options=None, product_sort_option=None, marketplace=None, page_size=10, page=None)[source]

Retrieves product data from the Jungle Scout Product Database.

Parameters:

  • include_keywords (Optional[List[str]]) – List of keywords or ASINs to include in the search.

  • exclude_keywords (Optional[List[str]]) – List of keywords or ASINs to exclude from the search.

  • categories (Optional[List[str]]) – List of categories to filter the search by. Must be valid inside the categories of the selected Marketplace.

  • collapse_by_parent (Optional[bool]) – Collapses the results to return only parent ASINs.

  • product_tiers (Optional[List[ProductTiers]]) – List of product tiers to filter the search by. Must use the ProductTiers enum.

  • seller_types (Optional[List[SellerTypes]]) – List of seller types to filter the search by. Must use the SellerTypes enum.

  • product_filter_options (Optional[ProductFilterOptions]) – Additional product filter options. Must use the ProductFilterOptions class.

  • product_sort_option (Optional[ProductSort]) – Sorting option for the search results. Must use the ProductSort enum.

  • marketplace (Optional[Marketplace]) – Marketplace to search in. If not provided, the default marketplace will be used.

  • page_size (Optional[int]) – Number of results to retrieve per page. Defaults to 10.

  • page (Optional[str]) – Page token for pagination.

Return type:

APIResponse[List[ProductDatabase]]

Returns:

The response from the API.

Raises:

Exception – If the request to the Jungle Scout API fails.

sales_estimates(asin, start_date, end_date, sort_option=None, marketplace=None)[source]

Retrieves sales estimates for a given ASIN within a specified date range.

Parameters:

  • asin (str) – The ASIN (Amazon Standard Identification Number) of the product.

  • start_date (str) – The start date of the date range in the format ‘YYYY-MM-DD’.

  • end_date (str) – The end date of the date range in the format ‘YYYY-MM-DD’.

  • sort_option (Optional[Sort]) – The sort option for the sales estimates. Must use the Sort enum.

  • marketplace (Optional[Marketplace]) – The marketplace to retrieve sales estimates from. If not provided, the marketplace provided at the client level will be used.

Return type:

APIResponse[List[SalesEstimates]]

Returns:

The response from the API.

Raises:

Exception – If the API request fails or returns an error response.

property session: SyncSession

The session used to make requests to the Jungle Scout API.

share_of_voice(keyword, marketplace=None)[source]

Retrieves the share of voice for a given keyword in the specified marketplace.

Parameters:

  • keyword (str) – The keyword for which to retrieve the share of voice.

  • marketplace (Optional[Marketplace]) – The marketplace in which to retrieve the share of voice. If not provided, the default marketplace will be used.

Return type:

APIResponse[ShareOfVoice]

Returns:

The response from the API.

Asynchronous Client

API Reference for Asynchronous Jungle Scout API.

class junglescout.client_async.ClientAsync(api_key_name, api_key, api_type=ApiType.JS, marketplace=None)[source]

The Jungle Scout Asynchronous API client.

This client provides async/await support for making non-blocking requests to the Jungle Scout API. All API methods are coroutines that should be awaited.

async close()[source]

Closes all connections used by the client.

Return type:

None

async historical_search_volume(keyword, start_date, end_date, sort_option=None, marketplace=None)[source]

Retrieves the historical search volume for a given keyword within a specified date range.

This is a coroutine that must be awaited.

Parameters:

  • keyword (str) – The keyword for which to retrieve the historical search volume.

  • start_date (str) – The start date of the date range in the format ‘YYYY-MM-DD’.

  • end_date (str) – The end date of the date range in the format ‘YYYY-MM-DD’.

  • sort_option (Optional[Sort]) – The sort option for the search volume data. Must use the Sort enum.

  • marketplace (Optional[Marketplace]) – The marketplace for which to retrieve the search volume data. If not provided, the default marketplace will be used.

Return type:

APIResponse[List[HistoricalSearchVolume]]

Returns:

The response from the API.

Raises:

Exception – If the request to retrieve the historical search volume fails.

property is_closed: bool

Boolean indicating if the client session is closed.

async keywords_by_asin(asin, include_variants=True, filter_options=None, sort_option=None, marketplace=None, page_size=None, page=None)[source]

Get keywords by ASIN.

This is a coroutine that must be awaited.

Parameters:

  • asin (Union[str, List[str]]) – The ASIN (Amazon Standard Identification Number) of the product. This can be a list of ASINs or a single ASIN.

  • include_variants (bool) – Include variants in the response.

  • filter_options (Optional[FilterOptions]) – Filter options for the request.

  • sort_option (Optional[Sort]) – Sort option for the request. This is equivalent to -sort_option in the API.

  • marketplace (Optional[Marketplace]) – The Amazon marketplace.

  • page_size (Optional[int]) – The number of results to return per page.

  • page (Optional[str]) – The page to return.

Return type:

APIResponse[List[KeywordByASIN]]

Returns:

The response from the API.

async keywords_by_keyword(search_terms, categories=None, filter_options=None, sort_option=None, marketplace=None, page_size=None, page=None)[source]

Retrieves keyword data based on the provided search terms.

This is a coroutine that must be awaited.

Parameters:

  • search_terms (str) – The search terms to retrieve keyword data for.

  • categories (Optional[List[str]]) – A list of category names to filter the results by. Must be valid inside the categories of the selected Marketplace.

  • filter_options (Optional[FilterOptions]) – The filter options to apply to the results.

  • sort_option (Optional[Sort]) – The sort option to apply to the results.

  • marketplace (Optional[Marketplace]) – The marketplace to retrieve keyword data from. If not provided, the marketplace provided at the client level will be used.

  • page_size (Optional[int]) – The number of results to retrieve per page.

  • page (Optional[str]) – The page token to retrieve a specific page of results. Used in pagination

Return type:

APIResponse[List[KeywordByKeyword]]

Returns:

The response from the API.

Raises:

Exception – If the request to retrieve keyword data fails.

async product_database(include_keywords=None, exclude_keywords=None, collapse_by_parent=None, categories=None, product_tiers=None, seller_types=None, product_filter_options=None, product_sort_option=None, marketplace=None, page_size=10, page=None)[source]

Retrieves product data from the Jungle Scout Product Database.

This is a coroutine that must be awaited.

Parameters:

  • include_keywords (Optional[List[str]]) – List of keywords or ASINs to include in the search.

  • exclude_keywords (Optional[List[str]]) – List of keywords or ASINs to exclude from the search.

  • categories (Optional[List[str]]) – List of categories to filter the search by. Must be valid inside the categories of the selected Marketplace.

  • collapse_by_parent (Optional[bool]) – Collapses the results to return only parent ASINs.

  • product_tiers (Optional[List[ProductTiers]]) – List of product tiers to filter the search by. Must use the ProductTiers enum.

  • seller_types (Optional[List[SellerTypes]]) – List of seller types to filter the search by. Must use the SellerTypes enum.

  • product_filter_options (Optional[ProductFilterOptions]) – Additional product filter options. Must use the ProductFilterOptions class.

  • product_sort_option (Optional[ProductSort]) – Sorting option for the search results. Must use the ProductSort enum.

  • marketplace (Optional[Marketplace]) – Marketplace to search in. If not provided, the default marketplace will be used.

  • page_size (Optional[int]) – Number of results to retrieve per page. Defaults to 10.

  • page (Optional[str]) – Page token for pagination.

Return type:

APIResponse[List[ProductDatabase]]

Returns:

The response from the API.

Raises:

Exception – If the request to the Jungle Scout API fails.

async sales_estimates(asin, start_date, end_date, sort_option=None, marketplace=None)[source]

Retrieves sales estimates for a given ASIN within a specified date range.

This is a coroutine that must be awaited.

Parameters:

  • asin (str) – The ASIN (Amazon Standard Identification Number) of the product.

  • start_date (str) – The start date of the date range in the format ‘YYYY-MM-DD’.

  • end_date (str) – The end date of the date range in the format ‘YYYY-MM-DD’.

  • sort_option (Optional[Sort]) – The sort option for the sales estimates. Must use the Sort enum.

  • marketplace (Optional[Marketplace]) – The marketplace to retrieve sales estimates from. If not provided, the marketplace provided at the client level will be used.

Return type:

APIResponse[List[SalesEstimates]]

Returns:

The response from the API.

Raises:

Exception – If the API request fails or returns an error response.

property session: AsyncSession

The session used to make requests to the Jungle Scout API.

async share_of_voice(keyword, marketplace=None)[source]

Retrieves the share of voice for a given keyword in the specified marketplace.

This is a coroutine that must be awaited.

Parameters:

  • keyword (str) – The keyword for which to retrieve the share of voice.

  • marketplace (Optional[Marketplace]) – The marketplace in which to retrieve the share of voice. If not provided, the default marketplace will be used.

Return type:

APIResponse[ShareOfVoice]

Returns:

The response from the API.

Parameters

References for the parameters used in the Jungle Scout API.

This package defines the models parameters that are used to make requests to the Jungle Scout API.

class junglescout.models.parameters.ApiType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Represents the type of API used by the Jungle Scout Python client.

- JS

The Jungle Scout API.

- COBALT

The Cobalt API.

pydantic model junglescout.models.parameters.Attributes[source]

Base model class with the basic attributes for filtering options.

- filter_options

The filter options for attributes. Must be a valid FilterOptions object.

Show JSON schema
{
   "title": "Attributes",
   "description": "Base model class with the basic attributes for filtering options.\n\nAttributes:\n    - filter_options: The filter options for attributes. Must be a valid FilterOptions object.",
   "type": "object",
   "properties": {
      "filter_options": {
         "anyOf": [
            {
               "$ref": "#/$defs/FilterOptions"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "FilterOptions": {
         "description": "Represents the filter options for searching products.\n\nAttributes:\n    - min_monthly_search_volume_exact: The minimum exact monthly search volume.\n    - max_monthly_search_volume_exact: The maximum exact monthly search volume.\n    - min_monthly_search_volume_broad: The minimum broad monthly search volume.\n    - max_monthly_search_volume_broad: The maximum broad monthly search volume.\n    - min_word_count: The minimum word count.\n    - max_word_count: The maximum word count.\n    - min_organic_product_count: The minimum organic product count.\n    - max_organic_product_count: The maximum organic product count.\n\nUsage:\n    FilterOptions(min_monthly_search_volume_exact=150)",
         "properties": {
            "min_monthly_search_volume_exact": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Min Monthly Search Volume Exact"
            },
            "max_monthly_search_volume_exact": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Max Monthly Search Volume Exact"
            },
            "min_monthly_search_volume_broad": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Min Monthly Search Volume Broad"
            },
            "max_monthly_search_volume_broad": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Max Monthly Search Volume Broad"
            },
            "min_word_count": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Min Word Count"
            },
            "max_word_count": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Max Word Count"
            },
            "min_organic_product_count": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Min Organic Product Count"
            },
            "max_organic_product_count": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Max Organic Product Count"
            }
         },
         "title": "FilterOptions",
         "type": "object"
      }
   }
}

Fields:

  • filter_options (junglescout.models.parameters.filter_options.FilterOptions | None)

field filter_options: Optional[FilterOptions] = None
pydantic model junglescout.models.parameters.FilterOptions[source]

Represents the filter options for searching products.

- min_monthly_search_volume_exact

The minimum exact monthly search volume.

- max_monthly_search_volume_exact

The maximum exact monthly search volume.

- min_monthly_search_volume_broad

The minimum broad monthly search volume.

- max_monthly_search_volume_broad

The maximum broad monthly search volume.

- min_word_count

The minimum word count.

- max_word_count

The maximum word count.

- min_organic_product_count

The minimum organic product count.

- max_organic_product_count

The maximum organic product count.

Usage:

FilterOptions(min_monthly_search_volume_exact=150)

Show JSON schema
{
   "title": "FilterOptions",
   "description": "Represents the filter options for searching products.\n\nAttributes:\n    - min_monthly_search_volume_exact: The minimum exact monthly search volume.\n    - max_monthly_search_volume_exact: The maximum exact monthly search volume.\n    - min_monthly_search_volume_broad: The minimum broad monthly search volume.\n    - max_monthly_search_volume_broad: The maximum broad monthly search volume.\n    - min_word_count: The minimum word count.\n    - max_word_count: The maximum word count.\n    - min_organic_product_count: The minimum organic product count.\n    - max_organic_product_count: The maximum organic product count.\n\nUsage:\n    FilterOptions(min_monthly_search_volume_exact=150)",
   "type": "object",
   "properties": {
      "min_monthly_search_volume_exact": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Monthly Search Volume Exact"
      },
      "max_monthly_search_volume_exact": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Monthly Search Volume Exact"
      },
      "min_monthly_search_volume_broad": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Monthly Search Volume Broad"
      },
      "max_monthly_search_volume_broad": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Monthly Search Volume Broad"
      },
      "min_word_count": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Word Count"
      },
      "max_word_count": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Word Count"
      },
      "min_organic_product_count": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Organic Product Count"
      },
      "max_organic_product_count": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Organic Product Count"
      }
   }
}

Fields:

  • max_monthly_search_volume_broad (int | None)

  • max_monthly_search_volume_exact (int | None)

  • max_organic_product_count (int | None)

  • max_word_count (int | None)

  • min_monthly_search_volume_broad (int | None)

  • min_monthly_search_volume_exact (int | None)

  • min_organic_product_count (int | None)

  • min_word_count (int | None)

field max_monthly_search_volume_broad: Optional[int] = None
Constraints:

  • ge = 0

field max_monthly_search_volume_exact: Optional[int] = None
Constraints:

  • ge = 0

field max_organic_product_count: Optional[int] = None
Constraints:

  • ge = 0

field max_word_count: Optional[int] = None
Constraints:

  • ge = 0

field min_monthly_search_volume_broad: Optional[int] = None
Constraints:

  • ge = 0

field min_monthly_search_volume_exact: Optional[int] = None
Constraints:

  • ge = 0

field min_organic_product_count: Optional[int] = None
Constraints:

  • ge = 0

field min_word_count: Optional[int] = None
Constraints:

  • ge = 0

class junglescout.models.parameters.Marketplace(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum that represents all the supported marketplaces with its country code and categories.

It’s used by default when instantiating the Jungle Scout client, but can be overridden by passing the marketplace parameter to some of the client’s methods.

property categories

Get the list of categories available in the marketplace.

Returns:

The list of categories.

Return type:

list

property country_code

Get the country code of the marketplace.

Returns:

The country code.

Return type:

str

pydantic model junglescout.models.parameters.Params[source]

Represents the parameters for a request to the Jungle Scout API.

Show JSON schema
{
   "title": "Params",
   "description": "Represents the parameters for a request to the Jungle Scout API.",
   "type": "object",
   "properties": {
      "marketplace": {
         "allOf": [
            {
               "$ref": "#/$defs/Marketplace"
            }
         ],
         "description": "The marketplace to query."
      },
      "sort": {
         "anyOf": [
            {
               "$ref": "#/$defs/Sort"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sorting option for the results. Must be a valid Sort object."
      },
      "page": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The cursor for pagination.",
         "title": "Page"
      },
      "page_size": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 50,
         "description": "The number of results per page.",
         "title": "Page Size"
      }
   },
   "$defs": {
      "Marketplace": {
         "description": "Enum that represents all the supported marketplaces with its country code and categories.\n\nIt's used by default when instantiating the Jungle Scout client, but can be overridden by passing\nthe marketplace parameter to some of the client's methods.",
         "enum": [
            [
               "us",
               [
                  "Appliances",
                  "Arts, Crafts & Sewing",
                  "Automotive",
                  "Baby",
                  "Beauty & Personal Care",
                  "Camera & Photo",
                  "Cell Phones & Accessories",
                  "Clothing, Shoes & Jewelry",
                  "Computers & Accessories",
                  "Electronics",
                  "Grocery & Gourmet Food",
                  "Health & Household",
                  "Home & Kitchen",
                  "Industrial & Scientific",
                  "Kitchen & Dining",
                  "Musical Instruments",
                  "Office Products",
                  "Patio, Lawn & Garden",
                  "Pet Supplies",
                  "Software",
                  "Sports & Outdoors",
                  "Tools & Home Improvement",
                  "Toys & Games",
                  "Video Games"
               ]
            ],
            [
               "uk",
               [
                  "Automotive",
                  "Baby Products",
                  "Beauty",
                  "Business, Industry & Science",
                  "Clothing",
                  "Computers & Accessories",
                  "DIY & Tools",
                  "Electronics & Photo",
                  "Garden & Outdoors",
                  "Grocery",
                  "Health & Personal Care",
                  "Home & Kitchen",
                  "Jewellery",
                  "Large Appliances",
                  "Lighting",
                  "Luggage",
                  "Musical Instruments & DJ",
                  "PC & Video Games",
                  "Pet Supplies",
                  "Shoes & Bags",
                  "Sports & Outdoors",
                  "Stationery & Office Supplies",
                  "Toys & Games",
                  "Watches"
               ]
            ],
            [
               "ca",
               [
                  "Automotive",
                  "Baby",
                  "Beauty & Personal Care",
                  "Clothing & Accessories",
                  "Electronics",
                  "Grocery & Gourmet Food",
                  "Health & Personal Care",
                  "Industrial & Scientific",
                  "Jewelry",
                  "Luggage & Bags",
                  "Musical Instruments, Stage & Studio",
                  "Office Products",
                  "Patio, Lawn & Garden",
                  "Pet Supplies",
                  "Shoes & Handbags",
                  "Sports & Outdoors",
                  "Tools & Home Improvement",
                  "Toys & Games",
                  "Watches"
               ]
            ],
            [
               "de",
               [
                  "Auto & Motorrad",
                  "Baby",
                  "Baumarkt",
                  "Beauty",
                  "Bekleidung",
                  "Beleuchtung",
                  "B\u00fccher",
                  "B\u00fcrobedarf & Schreibwaren",
                  "Computer & Zubeh\u00f6r",
                  "DVD & Blu-ray",
                  "Drogerie & K\u00f6rperpflege",
                  "Elektro-Gro\u00dfger\u00e4te",
                  "Elektronik & Foto",
                  "Fremdsprachige B\u00fccher",
                  "Games",
                  "Garten",
                  "Gewerbe, Industrie & Wissenschaft",
                  "Haustier",
                  "Kamera & Foto",
                  "Koffer, Rucks\u00e4cke & Taschen",
                  "K\u00fcche, Haushalt & Wohnen",
                  "Lebensmittel & Getr\u00e4nke",
                  "Musikinstrumente & DJ-Equipment",
                  "Schmuck",
                  "Schuhe & Handtaschen",
                  "Software",
                  "Spielzeug",
                  "Sport & Freizeit",
                  "Uhren"
               ]
            ],
            [
               "fr",
               [
                  "Animalerie",
                  "Auto & Moto",
                  "Bagages",
                  "Beaut\u00e9 & Parfum",
                  "Bijoux",
                  "Bricolage",
                  "B\u00e9b\u00e9 & Pu\u00e9riculture",
                  "Chaussures & Sacs",
                  "Commerce, Industrie & Science",
                  "Cuisine & Maison",
                  "DVD & Blu-ray",
                  "Epicerie",
                  "Fournitures de bureau",
                  "Gros \u00e9lectrom\u00e9nager",
                  "High-tech",
                  "Hygi\u00e8ne & Sant\u00e9",
                  "Informatique",
                  "Instruments de musique & Sono",
                  "Jardin",
                  "Jeux & Jouets",
                  "Jeux vid\u00e9o",
                  "Livres",
                  "Livres anglais & \u00e9trangers",
                  "Logiciels",
                  "Luminaires & Eclairage",
                  "Montres",
                  "Sports & Loisirs",
                  "V\u00eatements"
               ]
            ],
            [
               "in",
               [
                  "Baby",
                  "Baby Products",
                  "Bags, Wallets & Luggage",
                  "Beauty",
                  "Books",
                  "Car & Motorbike",
                  "Clothing & Accessories",
                  "Electronics",
                  "Gift Cards",
                  "Grocery & Gourmet Foods",
                  "Health & Personal Care",
                  "Home & Kitchen",
                  "Industrial & Scientific",
                  "Jewellery",
                  "Movies & TV Shows",
                  "Music",
                  "Musical Instruments",
                  "Office Products",
                  "Pet Supplies",
                  "Shoes & Handbags",
                  "Software",
                  "Sports, Fitness & Outdoors",
                  "Toys & Games",
                  "Video Games",
                  "Watches"
               ]
            ],
            [
               "it",
               [
                  "Abbigliamento",
                  "Alimentari e cura della casa",
                  "Auto e Moto",
                  "Bellezza",
                  "Buoni regalo",
                  "CD e Vinili",
                  "Casa e cucina",
                  "Commercio, Industria e Scienza",
                  "Elettronica",
                  "Fai da te",
                  "Film e TV",
                  "Giardino e giardinaggio",
                  "Giochi e giocattoli",
                  "Gioielli",
                  "Illuminazione",
                  "Informatica",
                  "Kindle Store",
                  "Libri",
                  "Libri in altre lingue",
                  "Orologi",
                  "Prima infanzia",
                  "Salute e cura della persona",
                  "Scarpe e borse",
                  "Software",
                  "Sport e tempo libero",
                  "Valigeria",
                  "Videogiochi"
               ]
            ],
            [
               "es",
               [
                  "Apps y Juegos",
                  "Beb\u00e9",
                  "Belleza",
                  "Bricolaje y herramientas",
                  "Coche y moto",
                  "Deportes y aire libre",
                  "Electr\u00f3nica",
                  "Equipaje",
                  "Hogar y cocina",
                  "Iluminaci\u00f3n",
                  "Industria, empresas y ciencia",
                  "Inform\u00e1tica",
                  "Instrumentos musicales",
                  "Jard\u00edn",
                  "Joyer\u00eda",
                  "Juguetes y juegos",
                  "Libros",
                  "Oficina y papeler\u00eda",
                  "Pel\u00edculas y TV",
                  "Relojes",
                  "Ropa",
                  "Salud y cuidado personal",
                  "Software",
                  "Tienda Kindle",
                  "Videojuegos",
                  "Zapatos y complementos"
               ]
            ],
            [
               "mx",
               [
                  "Beb\u00e9",
                  "Deportes y Aire Libre",
                  "Electr\u00f3nicos",
                  "Herramientas y Mejoras del Hogar",
                  "Hogar y Cocina",
                  "Industria, Empresas y Ciencia",
                  "Instrumentos Musicales",
                  "Juguetes y Juegos",
                  "Libros",
                  "M\u00fasica",
                  "Oficina y papeler\u00eda",
                  "Ropa, Zapatos y Accesorios",
                  "Salud, Belleza y Cuidado Personal",
                  "Software",
                  "Tienda Kindle",
                  "Videojuegos"
               ]
            ],
            [
               "jp",
               [
                  "DIY\u30fb\u5de5\u5177\u30fb\u30ac\u30fc\u30c7\u30f3",
                  "\u304a\u3082\u3061\u3083",
                  "\u30b7\u30e5\u30fc\u30ba&\u30d0\u30c3\u30b0",
                  "\u30b8\u30e5\u30a8\u30ea\u30fc",
                  "\u30b9\u30dd\u30fc\u30c4&\u30a2\u30a6\u30c8\u30c9\u30a2",
                  "\u30c9\u30e9\u30c3\u30b0\u30b9\u30c8\u30a2",
                  "\u30d3\u30e5\u30fc\u30c6\u30a3\u30fc",
                  "\u30d9\u30d3\u30fc&\u30de\u30bf\u30cb\u30c6\u30a3",
                  "\u30da\u30c3\u30c8\u7528\u54c1",
                  "\u30db\u30d3\u30fc",
                  "\u30db\u30fc\u30e0&\u30ad\u30c3\u30c1\u30f3",
                  "\u5927\u578b\u5bb6\u96fb",
                  "\u5bb6\u96fb&\u30ab\u30e1\u30e9",
                  "\u6587\u623f\u5177\u30fb\u30aa\u30d5\u30a3\u30b9\u7528\u54c1",
                  "\u670d&\u30d5\u30a1\u30c3\u30b7\u30e7\u30f3\u5c0f\u7269",
                  "\u7523\u696d\u30fb\u7814\u7a76\u958b\u767a\u7528\u54c1",
                  "\u8155\u6642\u8a08",
                  "\u8eca&\u30d0\u30a4\u30af",
                  "\u98df\u54c1\u30fb\u98f2\u6599\u30fb\u304a\u9152"
               ]
            ]
         ],
         "title": "Marketplace",
         "type": "array"
      },
      "Sort": {
         "description": "Enum class representing the sorting options for a search query.\n\nAttributes:\n    - NAME: Sort by name.\n    - MONTHLY_TREND: Sort by monthly trend.\n    - MONTHLY_SEARCH_VOLUME_EXACT_MATCH: Sort by monthly search volume (exact match).\n    - QUARTERLY_TREND: Sort by quarterly trend.\n    - MONTHLY_SEARCH_VOLUME_BROAD: Sort by monthly search volume (broad match).\n    - DOMINANT_CATEGORY: Sort by dominant category.\n    - RECOMMENDED_PROMOTIONS: Sort by recommended promotions.\n    - SP_BRAND_AD_BID: Sort by Sponsored Brand ad bid.\n    - PPC_BID_BROAD: Sort by PPC bid (broad match).\n    - PPC_BID_EXACT: Sort by PPC bid (exact match).\n    - EASE_OF_RANKING_SCORE: Sort by ease of ranking score.\n    - RELEVANCY_SCORE: Sort by relevancy score.\n    - ORGANIC_PRODUCT_COUNT: Sort by organic product count.",
         "enum": [
            "-name",
            "-monthly_trend",
            "-monthly_search_volume_exact",
            "-quarterly_trend",
            "-monthly_search_volume_broad",
            "-dominant_category",
            "-recommended_promotions",
            "-sp_brand_ad_bid",
            "-ppc_bid_broad",
            "-ppc_bid_exact",
            "-ease_of_ranking_score",
            "-relevancy_score",
            "-organic_product_count"
         ],
         "title": "Sort",
         "type": "string"
      }
   },
   "required": [
      "marketplace"
   ]
}

Fields:

  • marketplace (junglescout.models.parameters.marketplace.Marketplace)

  • page (str | None)

  • page_size (int | None)

  • sort (junglescout.models.parameters.sort.Sort | None)

field marketplace: Marketplace [Required]

The marketplace to query.

field page: Optional[str] = None

The cursor for pagination.

field page_size: Optional[int] = 50

The number of results per page.

field sort: Optional[Sort] = None

The sorting option for the results. Must be a valid Sort object.

pydantic model junglescout.models.parameters.ProductFilterOptions[source]

Represents the filter options for product filtering.

This class is used to filter products based on their attributes, used on Product Database.

- exclude_top_brands

Whether to exclude top brands.

- exclude_unavailable_products

Whether to exclude unavailable products.

- min_price

The minimum price of the products.

- max_price

The maximum price of the products.

- min_net

The minimum net value of the products.

- max_net

The maximum net value of the products.

- min_rank

The minimum rank of the products.

- max_rank

The maximum rank of the products.

- min_sales

The minimum sales of the products.

- max_sales

The maximum sales of the products.

- min_revenue

The minimum revenue of the products.

- max_revenue

The maximum revenue of the products.

- min_reviews

The minimum number of reviews of the products.

- max_reviews

The maximum number of reviews of the products.

- min_rating

The minimum rating of the products.

- max_rating

The maximum rating of the products.

- min_weight

The minimum weight of the products.

- max_weight

The maximum weight of the products.

- min_sellers

The minimum number of sellers of the products.

- max_sellers

The maximum number of sellers of the products.

- min_lqs

The minimum LQS (Listing Quality Score) of the products.

- max_lqs

The maximum LQS (Listing Quality Score) of the products.

- min_updated_at

The minimum updated date of the products in the format “YYYY-MM-DD”.

- max_updated_at

The maximum updated date of the products in the format “YYYY-MM-DD”.

Show JSON schema
{
   "title": "ProductFilterOptions",
   "description": "Represents the filter options for product filtering.\n\nThis class is used to filter products based on their attributes, used on Product Database.\n\nAttributes:\n    - exclude_top_brands: Whether to exclude top brands.\n    - exclude_unavailable_products: Whether to exclude unavailable products.\n    - min_price: The minimum price of the products.\n    - max_price: The maximum price of the products.\n    - min_net: The minimum net value of the products.\n    - max_net: The maximum net value of the products.\n    - min_rank: The minimum rank of the products.\n    - max_rank: The maximum rank of the products.\n    - min_sales: The minimum sales of the products.\n    - max_sales: The maximum sales of the products.\n    - min_revenue: The minimum revenue of the products.\n    - max_revenue: The maximum revenue of the products.\n    - min_reviews: The minimum number of reviews of the products.\n    - max_reviews: The maximum number of reviews of the products.\n    - min_rating: The minimum rating of the products.\n    - max_rating: The maximum rating of the products.\n    - min_weight: The minimum weight of the products.\n    - max_weight: The maximum weight of the products.\n    - min_sellers: The minimum number of sellers of the products.\n    - max_sellers: The maximum number of sellers of the products.\n    - min_lqs: The minimum LQS (Listing Quality Score) of the products.\n    - max_lqs: The maximum LQS (Listing Quality Score) of the products.\n    - min_updated_at: The minimum updated date of the products in the format \"YYYY-MM-DD\".\n    - max_updated_at: The maximum updated date of the products in the format \"YYYY-MM-DD\".",
   "type": "object",
   "properties": {
      "exclude_top_brands": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Exclude Top Brands"
      },
      "exclude_unavailable_products": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Exclude Unavailable Products"
      },
      "min_price": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Price"
      },
      "max_price": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Price"
      },
      "min_net": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Net"
      },
      "max_net": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Net"
      },
      "min_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Rank"
      },
      "max_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Rank"
      },
      "min_sales": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Sales"
      },
      "max_sales": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Sales"
      },
      "min_revenue": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Revenue"
      },
      "max_revenue": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Revenue"
      },
      "min_reviews": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Reviews"
      },
      "max_reviews": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Reviews"
      },
      "min_rating": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Rating"
      },
      "max_rating": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Rating"
      },
      "min_weight": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Weight"
      },
      "max_weight": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Weight"
      },
      "min_sellers": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Sellers"
      },
      "max_sellers": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Sellers"
      },
      "min_lqs": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Lqs"
      },
      "max_lqs": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Lqs"
      },
      "min_updated_at": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Min Updated At"
      },
      "max_updated_at": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Updated At"
      }
   }
}

Fields:

  • exclude_top_brands (bool | None)

  • exclude_unavailable_products (bool | None)

  • max_lqs (int | None)

  • max_net (int | None)

  • max_price (int | None)

  • max_rank (int | None)

  • max_rating (int | None)

  • max_revenue (int | None)

  • max_reviews (int | None)

  • max_sales (int | None)

  • max_sellers (int | None)

  • max_updated_at (str | None)

  • max_weight (int | None)

  • min_lqs (int | None)

  • min_net (int | None)

  • min_price (int | None)

  • min_rank (int | None)

  • min_rating (int | None)

  • min_revenue (int | None)

  • min_reviews (int | None)

  • min_sales (int | None)

  • min_sellers (int | None)

  • min_updated_at (str | None)

  • min_weight (int | None)

Validators:

  • _validate_date_format » max_updated_at

  • _validate_date_format » min_updated_at

field exclude_top_brands: Optional[bool] = None
field exclude_unavailable_products: Optional[bool] = None
field max_lqs: Optional[int] = None
field max_net: Optional[int] = None
field max_price: Optional[int] = None
field max_rank: Optional[int] = None
field max_rating: Optional[int] = None
field max_revenue: Optional[int] = None
field max_reviews: Optional[int] = None
field max_sales: Optional[int] = None
field max_sellers: Optional[int] = None
field max_updated_at: Optional[str] = None
Validated by:

  • _validate_date_format

field max_weight: Optional[int] = None
field min_lqs: Optional[int] = None
field min_net: Optional[int] = None
field min_price: Optional[int] = None
field min_rank: Optional[int] = None
field min_rating: Optional[int] = None
field min_revenue: Optional[int] = None
field min_reviews: Optional[int] = None
field min_sales: Optional[int] = None
field min_sellers: Optional[int] = None
field min_updated_at: Optional[str] = None
Validated by:

  • _validate_date_format

field min_weight: Optional[int] = None
class junglescout.models.parameters.ProductSort(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum class representing the sorting options for products.

Each option is represented by a string value prefixed with a hyphen (-).

Attributtes:

  • NAME: Sort by name.

  • CATEGORY: Sort by category.

  • REVENUE: Sort by revenue.

  • SALES: Sort by sales.

  • PRICE: Sort by price.

  • RANK: Sort by rank.

  • REVIEWS: Sort by reviews.

  • LQS: Sort by LQS (Listing Quality Score).

  • SELLERS: Sort by sellers.

class junglescout.models.parameters.ProductTiers(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum representing the different product tiers.

- OVERSIZE

Represents the oversize product tier.

- STANDARD

Represents the standard product tier.

class junglescout.models.parameters.SellerTypes(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum class representing different types of sellers.

- AMZ

Represents the Amazon seller type.

- FBA

Represents the Fulfilled by Amazon (FBA) seller type.

- FBM

Represents the Fulfilled by Merchant (FBM) seller type.

class junglescout.models.parameters.Sort(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum class representing the sorting options for a search query.

- NAME

Sort by name.

- MONTHLY_TREND

Sort by monthly trend.

- MONTHLY_SEARCH_VOLUME_EXACT_MATCH

Sort by monthly search volume (exact match).

- QUARTERLY_TREND

Sort by quarterly trend.

- MONTHLY_SEARCH_VOLUME_BROAD

Sort by monthly search volume (broad match).

- DOMINANT_CATEGORY

Sort by dominant category.

- RECOMMENDED_PROMOTIONS

Sort by recommended promotions.

- SP_BRAND_AD_BID

Sort by Sponsored Brand ad bid.

- PPC_BID_BROAD

Sort by PPC bid (broad match).

- PPC_BID_EXACT

Sort by PPC bid (exact match).

- EASE_OF_RANKING_SCORE

Sort by ease of ranking score.

- RELEVANCY_SCORE

Sort by relevancy score.

- ORGANIC_PRODUCT_COUNT

Sort by organic product count.

Responses

References for the responses returned by the Jungle Scout API.

Package for API response models.

pydantic model junglescout.models.responses.APIResponse[source]

Represents a response from the Jungle Scout API.

Show JSON schema
{
   "title": "APIResponse",
   "description": "Represents a response from the Jungle Scout API.",
   "type": "object",
   "properties": {
      "data": {
         "default": null,
         "description": "The data associated with the response.",
         "title": "Data"
      },
      "links": {
         "allOf": [
            {
               "$ref": "#/$defs/APIResponseLink"
            }
         ],
         "default": null,
         "description": "The links for the response."
      },
      "meta": {
         "allOf": [
            {
               "$ref": "#/$defs/APIResponseMeta"
            }
         ],
         "default": null,
         "description": "Additional metadata for the response."
      }
   },
   "$defs": {
      "APIResponseError": {
         "description": "Represents an error in a response from the Jungle Scout API.",
         "properties": {
            "title": {
               "description": "The title of the error.",
               "title": "Title",
               "type": "string"
            },
            "detail": {
               "description": "The detail of the error.",
               "title": "Detail",
               "type": "string"
            },
            "code": {
               "description": "The code of the error.",
               "title": "Code",
               "type": "string"
            },
            "status": {
               "description": "The status code for the error.",
               "title": "Status",
               "type": "string"
            }
         },
         "required": [
            "title",
            "detail",
            "code",
            "status"
         ],
         "title": "APIResponseError",
         "type": "object"
      },
      "APIResponseLink": {
         "description": "Represents the links for a response from the Jungle Scout API.",
         "properties": {
            "self": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The current link.",
               "title": "Self"
            },
            "next": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The next link.",
               "title": "Next"
            }
         },
         "title": "APIResponseLink",
         "type": "object"
      },
      "APIResponseMeta": {
         "description": "Represents additional metadata for a response from the Jungle Scout API.",
         "properties": {
            "total_items": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The total number of items in the response.",
               "title": "Total Items"
            },
            "errors": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/APIResponseError"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The errors in the response.",
               "title": "Errors"
            }
         },
         "title": "APIResponseMeta",
         "type": "object"
      }
   }
}

Fields:

  • data (junglescout.models.responses.api_response.DataT)

  • links (junglescout.models.responses.api_response.APIResponseLink)

  • meta (junglescout.models.responses.api_response.APIResponseMeta)

field data: TypeVar(DataT) = None

The data associated with the response.

The links for the response.

field meta: APIResponseMeta = None

Additional metadata for the response.

Represents the links for a response from the Jungle Scout API.

Show JSON schema
{
   "title": "APIResponseLink",
   "description": "Represents the links for a response from the Jungle Scout API.",
   "type": "object",
   "properties": {
      "self": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The current link.",
         "title": "Self"
      },
      "next": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The next link.",
         "title": "Next"
      }
   }
}

Fields:

  • next (str | None)

  • self (str | None)

field next: Optional[str] = None

The next link.

field self: Optional[str] = None

The current link.

pydantic model junglescout.models.responses.APIResponseMeta[source]

Represents additional metadata for a response from the Jungle Scout API.

Show JSON schema
{
   "title": "APIResponseMeta",
   "description": "Represents additional metadata for a response from the Jungle Scout API.",
   "type": "object",
   "properties": {
      "total_items": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The total number of items in the response.",
         "title": "Total Items"
      },
      "errors": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/APIResponseError"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The errors in the response.",
         "title": "Errors"
      }
   },
   "$defs": {
      "APIResponseError": {
         "description": "Represents an error in a response from the Jungle Scout API.",
         "properties": {
            "title": {
               "description": "The title of the error.",
               "title": "Title",
               "type": "string"
            },
            "detail": {
               "description": "The detail of the error.",
               "title": "Detail",
               "type": "string"
            },
            "code": {
               "description": "The code of the error.",
               "title": "Code",
               "type": "string"
            },
            "status": {
               "description": "The status code for the error.",
               "title": "Status",
               "type": "string"
            }
         },
         "required": [
            "title",
            "detail",
            "code",
            "status"
         ],
         "title": "APIResponseError",
         "type": "object"
      }
   }
}

Fields:

  • errors (List[junglescout.models.responses.api_response.APIResponseError] | None)

  • total_items (int | None)

field errors: Optional[List[APIResponseError]] = None

The errors in the response.

field total_items: Optional[int] = None

The total number of items in the response.

pydantic model junglescout.models.responses.HistoricalSearchVolume[source]

Represents a historical search volume response.

Show JSON schema
{
   "title": "HistoricalSearchVolume",
   "description": "Represents a historical search volume response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "The ID of the historical search volume.",
         "title": "Id",
         "type": "string"
      },
      "type": {
         "description": "The type of the historical search volume.",
         "title": "Type",
         "type": "string"
      },
      "attributes": {
         "allOf": [
            {
               "$ref": "#/$defs/HistoricalSearchVolumeAttributes"
            }
         ],
         "description": "Attributes for the response."
      }
   },
   "$defs": {
      "HistoricalSearchVolumeAttributes": {
         "description": "Attributes for historical search volume.",
         "properties": {
            "estimate_start_date": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The start date of the estimated search volume.",
               "title": "Estimate Start Date"
            },
            "estimate_end_date": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The end date of the estimated search volume.",
               "title": "Estimate End Date"
            },
            "estimated_exact_search_volume": {
               "description": "The estimated exact search volume.",
               "title": "Estimated Exact Search Volume",
               "type": "integer"
            }
         },
         "required": [
            "estimate_start_date",
            "estimate_end_date",
            "estimated_exact_search_volume"
         ],
         "title": "HistoricalSearchVolumeAttributes",
         "type": "object"
      }
   },
   "required": [
      "id",
      "type",
      "attributes"
   ]
}

Fields:

  • attributes (junglescout.models.responses.historical_search_volume.HistoricalSearchVolumeAttributes)

  • id (str)

  • type (str)

field attributes: HistoricalSearchVolumeAttributes [Required]

Attributes for the response.

field id: str [Required]

The ID of the historical search volume.

field type: str [Required]

The type of the historical search volume.

pydantic model junglescout.models.responses.HistoricalSearchVolumeAttributes[source]

Attributes for historical search volume.

Show JSON schema
{
   "title": "HistoricalSearchVolumeAttributes",
   "description": "Attributes for historical search volume.",
   "type": "object",
   "properties": {
      "estimate_start_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The start date of the estimated search volume.",
         "title": "Estimate Start Date"
      },
      "estimate_end_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The end date of the estimated search volume.",
         "title": "Estimate End Date"
      },
      "estimated_exact_search_volume": {
         "description": "The estimated exact search volume.",
         "title": "Estimated Exact Search Volume",
         "type": "integer"
      }
   },
   "required": [
      "estimate_start_date",
      "estimate_end_date",
      "estimated_exact_search_volume"
   ]
}

Fields:

  • estimate_end_date (datetime.datetime | None)

  • estimate_start_date (datetime.datetime | None)

  • estimated_exact_search_volume (int)

field estimate_end_date: Optional[datetime] [Required]

The end date of the estimated search volume.

field estimate_start_date: Optional[datetime] [Required]

The start date of the estimated search volume.

field estimated_exact_search_volume: int [Required]

The estimated exact search volume.

pydantic model junglescout.models.responses.KeywordAttributes[source]

Keyword attributes for a specific ASIN.

Show JSON schema
{
   "title": "KeywordAttributes",
   "description": "Keyword attributes for a specific ASIN.",
   "type": "object",
   "properties": {
      "country": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The country of the keyword.",
         "title": "Country"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the keyword.",
         "title": "Name"
      },
      "primary_asin": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The primary ASIN of the keyword.",
         "title": "Primary Asin"
      },
      "monthly_trend": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The monthly trend of the keyword.",
         "title": "Monthly Trend"
      },
      "monthly_search_volume_exact": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The monthly search volume exact of the keyword.",
         "title": "Monthly Search Volume Exact"
      },
      "quarterly_trend": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The quarterly trend of the keyword.",
         "title": "Quarterly Trend"
      },
      "monthly_search_volume_broad": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The monthly search volume broad of the keyword.",
         "title": "Monthly Search Volume Broad"
      },
      "dominant_category": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dominant category of the keyword.",
         "title": "Dominant Category"
      },
      "recommended_promotions": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The recommended promotions of the keyword.",
         "title": "Recommended Promotions"
      },
      "sp_brand_ad_bid": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The SP brand ad bid of the keyword.",
         "title": "Sp Brand Ad Bid"
      },
      "ppc_bid_broad": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The PPC bid broad of the keyword.",
         "title": "Ppc Bid Broad"
      },
      "ppc_bid_exact": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The PPC bid exact of the keyword.",
         "title": "Ppc Bid Exact"
      },
      "ease_of_ranking_score": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ease of ranking score of the keyword.",
         "title": "Ease Of Ranking Score"
      },
      "relevancy_score": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relevancy score of the keyword.",
         "title": "Relevancy Score"
      },
      "organic_product_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic product count of the keyword.",
         "title": "Organic Product Count"
      },
      "sponsored_product_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored product count of the keyword.",
         "title": "Sponsored Product Count"
      },
      "updated_at": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The date the keyword was last updated.",
         "title": "Updated At"
      },
      "organic_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic rank of the keyword.",
         "title": "Organic Rank"
      },
      "sponsored_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored rank of the keyword.",
         "title": "Sponsored Rank"
      },
      "overall_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The overall rank of the keyword.",
         "title": "Overall Rank"
      },
      "organic_ranking_asins_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic ranking ASINs count of the keyword.",
         "title": "Organic Ranking Asins Count"
      },
      "sponsored_ranking_asins_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored ranking ASINs count of the keyword.",
         "title": "Sponsored Ranking Asins Count"
      },
      "avg_competitor_organic_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average competitor organic rank of the keyword.",
         "title": "Avg Competitor Organic Rank"
      },
      "avg_competitor_sponsored_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average competitor sponsored rank of the keyword.",
         "title": "Avg Competitor Sponsored Rank"
      },
      "relative_organic_position": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative organic position of the keyword.",
         "title": "Relative Organic Position"
      },
      "relative_sponsored_position": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative sponsored position of the keyword.",
         "title": "Relative Sponsored Position"
      },
      "competitor_organic_rank": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/CompetitorRank"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The competitor organic rank of the keyword.",
         "title": "Competitor Organic Rank"
      },
      "competitor_sponsored_rank": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/SponsoredRank"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The competitor sponsored rank of the keyword.",
         "title": "Competitor Sponsored Rank"
      },
      "variation_lowest_organic_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The variation lowest organic rank of the keyword.",
         "title": "Variation Lowest Organic Rank"
      }
   },
   "$defs": {
      "CompetitorRank": {
         "description": "Represents a competitor's rank for a specific keyword.",
         "properties": {
            "asin": {
               "description": "The ASIN of the competitor.",
               "title": "Asin",
               "type": "string"
            },
            "organic_rank": {
               "description": "The organic rank of the competitor.",
               "title": "Organic Rank",
               "type": "integer"
            }
         },
         "required": [
            "asin",
            "organic_rank"
         ],
         "title": "CompetitorRank",
         "type": "object"
      },
      "SponsoredRank": {
         "description": "Represents a sponsored rank for a specific keyword.",
         "properties": {
            "asin": {
               "description": "The ASIN of the competitor.",
               "title": "Asin",
               "type": "string"
            },
            "sponsored_rank": {
               "description": "The sponsored rank of the competitor.",
               "title": "Sponsored Rank",
               "type": "integer"
            }
         },
         "required": [
            "asin",
            "sponsored_rank"
         ],
         "title": "SponsoredRank",
         "type": "object"
      }
   },
   "required": [
      "updated_at"
   ]
}

Fields:

  • avg_competitor_organic_rank (int | None)

  • avg_competitor_sponsored_rank (int | None)

  • competitor_organic_rank (List[junglescout.models.responses.keyword_by_asin.CompetitorRank] | None)

  • competitor_sponsored_rank (List[junglescout.models.responses.keyword_by_asin.SponsoredRank] | None)

  • country (str | None)

  • dominant_category (str | None)

  • ease_of_ranking_score (int | None)

  • monthly_search_volume_broad (int | None)

  • monthly_search_volume_exact (int | None)

  • monthly_trend (float | None)

  • name (str | None)

  • organic_product_count (int | None)

  • organic_rank (int | None)

  • organic_ranking_asins_count (int | None)

  • overall_rank (int | None)

  • ppc_bid_broad (float | None)

  • ppc_bid_exact (float | None)

  • primary_asin (str | None)

  • quarterly_trend (float | None)

  • recommended_promotions (int | None)

  • relative_organic_position (int | None)

  • relative_sponsored_position (int | None)

  • relevancy_score (int | None)

  • sp_brand_ad_bid (float | None)

  • sponsored_product_count (int | None)

  • sponsored_rank (int | None)

  • sponsored_ranking_asins_count (int | None)

  • updated_at (datetime.datetime | None)

  • variation_lowest_organic_rank (int | None)

field avg_competitor_organic_rank: Optional[int] = None

The average competitor organic rank of the keyword.

field avg_competitor_sponsored_rank: Optional[int] = None

The average competitor sponsored rank of the keyword.

field competitor_organic_rank: Optional[List[CompetitorRank]] = None

The competitor organic rank of the keyword.

field competitor_sponsored_rank: Optional[List[SponsoredRank]] = None

The competitor sponsored rank of the keyword.

field country: Optional[str] = None

The country of the keyword.

field dominant_category: Optional[str] = None

The dominant category of the keyword.

field ease_of_ranking_score: Optional[int] = None

The ease of ranking score of the keyword.

field monthly_search_volume_broad: Optional[int] = None

The monthly search volume broad of the keyword.

field monthly_search_volume_exact: Optional[int] = None

The monthly search volume exact of the keyword.

field monthly_trend: Optional[float] = None

The monthly trend of the keyword.

field name: Optional[str] = None

The name of the keyword.

field organic_product_count: Optional[int] = None

The organic product count of the keyword.

field organic_rank: Optional[int] = None

The organic rank of the keyword.

field organic_ranking_asins_count: Optional[int] = None

The organic ranking ASINs count of the keyword.

field overall_rank: Optional[int] = None

The overall rank of the keyword.

field ppc_bid_broad: Optional[float] = None

The PPC bid broad of the keyword.

field ppc_bid_exact: Optional[float] = None

The PPC bid exact of the keyword.

field primary_asin: Optional[str] = None

The primary ASIN of the keyword.

field quarterly_trend: Optional[float] = None

The quarterly trend of the keyword.

field recommended_promotions: Optional[int] = None

The recommended promotions of the keyword.

field relative_organic_position: Optional[int] = None

The relative organic position of the keyword.

field relative_sponsored_position: Optional[int] = None

The relative sponsored position of the keyword.

field relevancy_score: Optional[int] = None

The relevancy score of the keyword.

field sp_brand_ad_bid: Optional[float] = None

The SP brand ad bid of the keyword.

field sponsored_product_count: Optional[int] = None

The sponsored product count of the keyword.

field sponsored_rank: Optional[int] = None

The sponsored rank of the keyword.

field sponsored_ranking_asins_count: Optional[int] = None

The sponsored ranking ASINs count of the keyword.

field updated_at: Optional[datetime] [Required]

The date the keyword was last updated.

field variation_lowest_organic_rank: Optional[int] = None

The variation lowest organic rank of the keyword.

pydantic model junglescout.models.responses.KeywordByASIN[source]

represents a response object containing keyword data for a specific asin.

Show JSON schema
{
   "title": "KeywordByASIN",
   "description": "represents a response object containing keyword data for a specific asin.",
   "type": "object",
   "properties": {
      "id": {
         "description": "The ID of the keyword.",
         "title": "Id",
         "type": "string"
      },
      "type": {
         "description": "The type of the keyword.",
         "title": "Type",
         "type": "string"
      },
      "attributes": {
         "allOf": [
            {
               "$ref": "#/$defs/KeywordAttributes"
            }
         ],
         "description": "The attributes for the keyword."
      }
   },
   "$defs": {
      "CompetitorRank": {
         "description": "Represents a competitor's rank for a specific keyword.",
         "properties": {
            "asin": {
               "description": "The ASIN of the competitor.",
               "title": "Asin",
               "type": "string"
            },
            "organic_rank": {
               "description": "The organic rank of the competitor.",
               "title": "Organic Rank",
               "type": "integer"
            }
         },
         "required": [
            "asin",
            "organic_rank"
         ],
         "title": "CompetitorRank",
         "type": "object"
      },
      "KeywordAttributes": {
         "description": "Keyword attributes for a specific ASIN.",
         "properties": {
            "country": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The country of the keyword.",
               "title": "Country"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the keyword.",
               "title": "Name"
            },
            "primary_asin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The primary ASIN of the keyword.",
               "title": "Primary Asin"
            },
            "monthly_trend": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The monthly trend of the keyword.",
               "title": "Monthly Trend"
            },
            "monthly_search_volume_exact": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The monthly search volume exact of the keyword.",
               "title": "Monthly Search Volume Exact"
            },
            "quarterly_trend": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The quarterly trend of the keyword.",
               "title": "Quarterly Trend"
            },
            "monthly_search_volume_broad": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The monthly search volume broad of the keyword.",
               "title": "Monthly Search Volume Broad"
            },
            "dominant_category": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The dominant category of the keyword.",
               "title": "Dominant Category"
            },
            "recommended_promotions": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The recommended promotions of the keyword.",
               "title": "Recommended Promotions"
            },
            "sp_brand_ad_bid": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The SP brand ad bid of the keyword.",
               "title": "Sp Brand Ad Bid"
            },
            "ppc_bid_broad": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The PPC bid broad of the keyword.",
               "title": "Ppc Bid Broad"
            },
            "ppc_bid_exact": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The PPC bid exact of the keyword.",
               "title": "Ppc Bid Exact"
            },
            "ease_of_ranking_score": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ease of ranking score of the keyword.",
               "title": "Ease Of Ranking Score"
            },
            "relevancy_score": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The relevancy score of the keyword.",
               "title": "Relevancy Score"
            },
            "organic_product_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic product count of the keyword.",
               "title": "Organic Product Count"
            },
            "sponsored_product_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored product count of the keyword.",
               "title": "Sponsored Product Count"
            },
            "updated_at": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The date the keyword was last updated.",
               "title": "Updated At"
            },
            "organic_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic rank of the keyword.",
               "title": "Organic Rank"
            },
            "sponsored_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored rank of the keyword.",
               "title": "Sponsored Rank"
            },
            "overall_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The overall rank of the keyword.",
               "title": "Overall Rank"
            },
            "organic_ranking_asins_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic ranking ASINs count of the keyword.",
               "title": "Organic Ranking Asins Count"
            },
            "sponsored_ranking_asins_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored ranking ASINs count of the keyword.",
               "title": "Sponsored Ranking Asins Count"
            },
            "avg_competitor_organic_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The average competitor organic rank of the keyword.",
               "title": "Avg Competitor Organic Rank"
            },
            "avg_competitor_sponsored_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The average competitor sponsored rank of the keyword.",
               "title": "Avg Competitor Sponsored Rank"
            },
            "relative_organic_position": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The relative organic position of the keyword.",
               "title": "Relative Organic Position"
            },
            "relative_sponsored_position": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The relative sponsored position of the keyword.",
               "title": "Relative Sponsored Position"
            },
            "competitor_organic_rank": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/CompetitorRank"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The competitor organic rank of the keyword.",
               "title": "Competitor Organic Rank"
            },
            "competitor_sponsored_rank": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/SponsoredRank"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The competitor sponsored rank of the keyword.",
               "title": "Competitor Sponsored Rank"
            },
            "variation_lowest_organic_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The variation lowest organic rank of the keyword.",
               "title": "Variation Lowest Organic Rank"
            }
         },
         "required": [
            "updated_at"
         ],
         "title": "KeywordAttributes",
         "type": "object"
      },
      "SponsoredRank": {
         "description": "Represents a sponsored rank for a specific keyword.",
         "properties": {
            "asin": {
               "description": "The ASIN of the competitor.",
               "title": "Asin",
               "type": "string"
            },
            "sponsored_rank": {
               "description": "The sponsored rank of the competitor.",
               "title": "Sponsored Rank",
               "type": "integer"
            }
         },
         "required": [
            "asin",
            "sponsored_rank"
         ],
         "title": "SponsoredRank",
         "type": "object"
      }
   },
   "required": [
      "id",
      "type",
      "attributes"
   ]
}

Fields:

  • attributes (junglescout.models.responses.keyword_by_asin.KeywordAttributes)

  • id (str)

  • type (str)

field attributes: KeywordAttributes [Required]

The attributes for the keyword.

field id: str [Required]

The ID of the keyword.

field type: str [Required]

The type of the keyword.

pydantic model junglescout.models.responses.KeywordByKeyword[source]

Represents a response object containing keyword data.

Show JSON schema
{
   "title": "KeywordByKeyword",
   "description": "Represents a response object containing keyword data.",
   "type": "object",
   "properties": {
      "id": {
         "description": "The ID of the keyword.",
         "title": "Id",
         "type": "string"
      },
      "type": {
         "description": "The type of the keyword.",
         "title": "Type",
         "type": "string"
      },
      "attributes": {
         "allOf": [
            {
               "$ref": "#/$defs/KeywordByKeywordAttributes"
            }
         ],
         "description": "Attributes for the response."
      }
   },
   "$defs": {
      "KeywordByKeywordAttributes": {
         "description": "Attributes for keyword.",
         "properties": {
            "country": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The country of the keyword.",
               "title": "Country"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The name of the keyword.",
               "title": "Name"
            },
            "monthly_trend": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The monthly trend of the keyword.",
               "title": "Monthly Trend"
            },
            "monthly_search_volume_exact": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The monthly search volume exact of the keyword.",
               "title": "Monthly Search Volume Exact"
            },
            "quarterly_trend": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The quarterly trend of the keyword.",
               "title": "Quarterly Trend"
            },
            "monthly_search_volume_broad": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The monthly search volume broad of the keyword.",
               "title": "Monthly Search Volume Broad"
            },
            "dominant_category": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The dominant category of the keyword.",
               "title": "Dominant Category"
            },
            "recommended_promotions": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The recommended promotions of the keyword.",
               "title": "Recommended Promotions"
            },
            "sp_brand_ad_bid": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The SP brand ad bid of the keyword.",
               "title": "Sp Brand Ad Bid"
            },
            "ppc_bid_broad": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The PPC bid broad of the keyword.",
               "title": "Ppc Bid Broad"
            },
            "ppc_bid_exact": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The PPC bid exact of the keyword.",
               "title": "Ppc Bid Exact"
            },
            "ease_of_ranking_score": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ease of ranking score of the keyword.",
               "title": "Ease Of Ranking Score"
            },
            "relevancy_score": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The relevancy score of the keyword.",
               "title": "Relevancy Score"
            },
            "organic_product_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic product count of the keyword.",
               "title": "Organic Product Count"
            },
            "sponsored_product_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored product count of the keyword.",
               "title": "Sponsored Product Count"
            }
         },
         "required": [
            "country",
            "name",
            "recommended_promotions"
         ],
         "title": "KeywordByKeywordAttributes",
         "type": "object"
      }
   },
   "required": [
      "id",
      "type",
      "attributes"
   ]
}

Fields:

  • attributes (junglescout.models.responses.keyword_by_keyword.KeywordByKeywordAttributes)

  • id (str)

  • type (str)

field attributes: KeywordByKeywordAttributes [Required]

Attributes for the response.

field id: str [Required]

The ID of the keyword.

field type: str [Required]

The type of the keyword.

pydantic model junglescout.models.responses.KeywordByKeywordAttributes[source]

Attributes for keyword.

Show JSON schema
{
   "title": "KeywordByKeywordAttributes",
   "description": "Attributes for keyword.",
   "type": "object",
   "properties": {
      "country": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The country of the keyword.",
         "title": "Country"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The name of the keyword.",
         "title": "Name"
      },
      "monthly_trend": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The monthly trend of the keyword.",
         "title": "Monthly Trend"
      },
      "monthly_search_volume_exact": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The monthly search volume exact of the keyword.",
         "title": "Monthly Search Volume Exact"
      },
      "quarterly_trend": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The quarterly trend of the keyword.",
         "title": "Quarterly Trend"
      },
      "monthly_search_volume_broad": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The monthly search volume broad of the keyword.",
         "title": "Monthly Search Volume Broad"
      },
      "dominant_category": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dominant category of the keyword.",
         "title": "Dominant Category"
      },
      "recommended_promotions": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "description": "The recommended promotions of the keyword.",
         "title": "Recommended Promotions"
      },
      "sp_brand_ad_bid": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The SP brand ad bid of the keyword.",
         "title": "Sp Brand Ad Bid"
      },
      "ppc_bid_broad": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The PPC bid broad of the keyword.",
         "title": "Ppc Bid Broad"
      },
      "ppc_bid_exact": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The PPC bid exact of the keyword.",
         "title": "Ppc Bid Exact"
      },
      "ease_of_ranking_score": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ease of ranking score of the keyword.",
         "title": "Ease Of Ranking Score"
      },
      "relevancy_score": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relevancy score of the keyword.",
         "title": "Relevancy Score"
      },
      "organic_product_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic product count of the keyword.",
         "title": "Organic Product Count"
      },
      "sponsored_product_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored product count of the keyword.",
         "title": "Sponsored Product Count"
      }
   },
   "required": [
      "country",
      "name",
      "recommended_promotions"
   ]
}

Fields:

  • country (str | None)

  • dominant_category (str | None)

  • ease_of_ranking_score (int | None)

  • monthly_search_volume_broad (int | None)

  • monthly_search_volume_exact (int | None)

  • monthly_trend (float | None)

  • name (str | None)

  • organic_product_count (int | None)

  • ppc_bid_broad (float | None)

  • ppc_bid_exact (float | None)

  • quarterly_trend (float | None)

  • recommended_promotions (int | None)

  • relevancy_score (int | None)

  • sp_brand_ad_bid (float | None)

  • sponsored_product_count (int | None)

field country: Optional[str] [Required]

The country of the keyword.

field dominant_category: Optional[str] = None

The dominant category of the keyword.

field ease_of_ranking_score: Optional[int] = None

The ease of ranking score of the keyword.

field monthly_search_volume_broad: Optional[int] = None

The monthly search volume broad of the keyword.

field monthly_search_volume_exact: Optional[int] = None

The monthly search volume exact of the keyword.

field monthly_trend: Optional[float] = None

The monthly trend of the keyword.

field name: Optional[str] [Required]

The name of the keyword.

field organic_product_count: Optional[int] = None

The organic product count of the keyword.

field ppc_bid_broad: Optional[float] = None

The PPC bid broad of the keyword.

field ppc_bid_exact: Optional[float] = None

The PPC bid exact of the keyword.

field quarterly_trend: Optional[float] = None

The quarterly trend of the keyword.

field recommended_promotions: Optional[int] [Required]

The recommended promotions of the keyword.

field relevancy_score: Optional[int] = None

The relevancy score of the keyword.

field sp_brand_ad_bid: Optional[float] = None

The SP brand ad bid of the keyword.

field sponsored_product_count: Optional[int] = None

The sponsored product count of the keyword.

pydantic model junglescout.models.responses.ProductDatabase[source]

Represents a response from the product database API.

Show JSON schema
{
   "title": "ProductDatabase",
   "description": "Represents a response from the product database API.",
   "type": "object",
   "properties": {
      "id": {
         "description": "The ID of the product.",
         "title": "Id",
         "type": "string"
      },
      "type": {
         "description": "The type of the product.",
         "title": "Type",
         "type": "string"
      },
      "attributes": {
         "$ref": "#/$defs/ProductDatabaseAttributes"
      }
   },
   "$defs": {
      "ProductDatabaseAttributes": {
         "description": "Product database attributes.",
         "properties": {
            "title": {
               "description": "The title of the product.",
               "title": "Title",
               "type": "string"
            },
            "price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The price of the product.",
               "title": "Price"
            },
            "reviews": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of reviews for the product.",
               "title": "Reviews"
            },
            "category": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The category of the product.",
               "title": "Category"
            },
            "rating": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The rating of the product.",
               "title": "Rating"
            },
            "image_url": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The image URL of the product.",
               "title": "Image Url"
            },
            "parent_asin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent ASIN of the product.",
               "title": "Parent Asin"
            },
            "is_variant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Whether the product is a variant.",
               "title": "Is Variant"
            },
            "seller_type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The type of the seller.",
               "title": "Seller Type"
            },
            "variants": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of variants for the product.",
               "title": "Variants"
            },
            "is_standalone": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Whether the product is standalone.",
               "title": "Is Standalone"
            },
            "is_parent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Whether the product is a parent.",
               "title": "Is Parent"
            },
            "brand": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The brand of the product.",
               "title": "Brand"
            },
            "product_rank": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The rank of the product.",
               "title": "Product Rank"
            },
            "weight_value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The weight value of the product.",
               "title": "Weight Value"
            },
            "weight_unit": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The weight unit of the product.",
               "title": "Weight Unit"
            },
            "length_value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The length value of the product.",
               "title": "Length Value"
            },
            "width_value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The width value of the product.",
               "title": "Width Value"
            },
            "height_value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The height value of the product.",
               "title": "Height Value"
            },
            "dimensions_unit": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The dimensions unit of the product.",
               "title": "Dimensions Unit"
            },
            "listing_quality_score": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The listing quality score of the product.",
               "title": "Listing Quality Score"
            },
            "number_of_sellers": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of sellers for the product.",
               "title": "Number Of Sellers"
            },
            "buy_box_owner": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The buy box owner of the product.",
               "title": "Buy Box Owner"
            },
            "buy_box_owner_seller_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The buy box owner seller ID of the product.",
               "title": "Buy Box Owner Seller Id"
            },
            "date_first_available": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The date the product was first available.",
               "title": "Date First Available"
            },
            "date_first_available_is_estimated": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Whether the date the product was first available is estimated.",
               "title": "Date First Available Is Estimated"
            },
            "approximate_30_day_revenue": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The approximate 30 day revenue of the product.",
               "title": "Approximate 30 Day Revenue"
            },
            "approximate_30_day_units_sold": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The approximate 30 day units sold of the product.",
               "title": "Approximate 30 Day Units Sold"
            },
            "ean_list": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The EAN list of the product.",
               "title": "Ean List"
            },
            "isbn_list": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ISBN list of the product.",
               "title": "Isbn List"
            },
            "upc_list": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The UPC list of the product.",
               "title": "Upc List"
            },
            "gtin_list": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The GTIN list of the product.",
               "title": "Gtin List"
            },
            "variant_reviews": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The variant reviews of the product.",
               "title": "Variant Reviews"
            },
            "updated_at": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The date the product was last updated.",
               "title": "Updated At"
            },
            "subcategory_ranks": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProductDatabaseSubcategoryRanks"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The subcategory ranks of the product.",
               "title": "Subcategory Ranks"
            },
            "fee_breakdown": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ProductDatabaseFeeBreakdown"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The fee breakdown of the product."
            }
         },
         "required": [
            "title",
            "updated_at"
         ],
         "title": "ProductDatabaseAttributes",
         "type": "object"
      },
      "ProductDatabaseFeeBreakdown": {
         "description": "Represents a response object containing fee breakdown.",
         "properties": {
            "fba_fee": {
               "description": "The FBA fee of the product.",
               "title": "Fba Fee",
               "type": "number"
            },
            "referral_fee": {
               "description": "The referral fee of the product.",
               "title": "Referral Fee",
               "type": "number"
            },
            "variable_closing_fee": {
               "description": "The variable closing fee of the product.",
               "title": "Variable Closing Fee",
               "type": "number"
            },
            "total_fees": {
               "description": "The total fees of the product.",
               "title": "Total Fees",
               "type": "number"
            }
         },
         "required": [
            "fba_fee",
            "referral_fee",
            "variable_closing_fee",
            "total_fees"
         ],
         "title": "ProductDatabaseFeeBreakdown",
         "type": "object"
      },
      "ProductDatabaseSubcategoryRanks": {
         "description": "Represents a response object containing subcategory ranks.",
         "properties": {
            "subcategory": {
               "description": "The subcategory of the product.",
               "title": "Subcategory",
               "type": "string"
            },
            "rank": {
               "description": "The rank of the product.",
               "title": "Rank",
               "type": "integer"
            }
         },
         "required": [
            "subcategory",
            "rank"
         ],
         "title": "ProductDatabaseSubcategoryRanks",
         "type": "object"
      }
   },
   "required": [
      "id",
      "type",
      "attributes"
   ]
}

Fields:

  • attributes (junglescout.models.responses.product_database.ProductDatabaseAttributes)

  • id (str)

  • type (str)

field attributes: ProductDatabaseAttributes [Required]
field id: str [Required]

The ID of the product.

field type: str [Required]

The type of the product.

pydantic model junglescout.models.responses.ProductDatabaseAttributes[source]

Product database attributes.

Show JSON schema
{
   "title": "ProductDatabaseAttributes",
   "description": "Product database attributes.",
   "type": "object",
   "properties": {
      "title": {
         "description": "The title of the product.",
         "title": "Title",
         "type": "string"
      },
      "price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The price of the product.",
         "title": "Price"
      },
      "reviews": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of reviews for the product.",
         "title": "Reviews"
      },
      "category": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of the product.",
         "title": "Category"
      },
      "rating": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The rating of the product.",
         "title": "Rating"
      },
      "image_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The image URL of the product.",
         "title": "Image Url"
      },
      "parent_asin": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The parent ASIN of the product.",
         "title": "Parent Asin"
      },
      "is_variant": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether the product is a variant.",
         "title": "Is Variant"
      },
      "seller_type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The type of the seller.",
         "title": "Seller Type"
      },
      "variants": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of variants for the product.",
         "title": "Variants"
      },
      "is_standalone": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether the product is standalone.",
         "title": "Is Standalone"
      },
      "is_parent": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether the product is a parent.",
         "title": "Is Parent"
      },
      "brand": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The brand of the product.",
         "title": "Brand"
      },
      "product_rank": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The rank of the product.",
         "title": "Product Rank"
      },
      "weight_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The weight value of the product.",
         "title": "Weight Value"
      },
      "weight_unit": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The weight unit of the product.",
         "title": "Weight Unit"
      },
      "length_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The length value of the product.",
         "title": "Length Value"
      },
      "width_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The width value of the product.",
         "title": "Width Value"
      },
      "height_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The height value of the product.",
         "title": "Height Value"
      },
      "dimensions_unit": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dimensions unit of the product.",
         "title": "Dimensions Unit"
      },
      "listing_quality_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The listing quality score of the product.",
         "title": "Listing Quality Score"
      },
      "number_of_sellers": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of sellers for the product.",
         "title": "Number Of Sellers"
      },
      "buy_box_owner": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The buy box owner of the product.",
         "title": "Buy Box Owner"
      },
      "buy_box_owner_seller_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The buy box owner seller ID of the product.",
         "title": "Buy Box Owner Seller Id"
      },
      "date_first_available": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The date the product was first available.",
         "title": "Date First Available"
      },
      "date_first_available_is_estimated": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether the date the product was first available is estimated.",
         "title": "Date First Available Is Estimated"
      },
      "approximate_30_day_revenue": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The approximate 30 day revenue of the product.",
         "title": "Approximate 30 Day Revenue"
      },
      "approximate_30_day_units_sold": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The approximate 30 day units sold of the product.",
         "title": "Approximate 30 Day Units Sold"
      },
      "ean_list": {
         "anyOf": [
            {
               "items": {
                  "type": "integer"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The EAN list of the product.",
         "title": "Ean List"
      },
      "isbn_list": {
         "anyOf": [
            {
               "items": {
                  "type": "integer"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ISBN list of the product.",
         "title": "Isbn List"
      },
      "upc_list": {
         "anyOf": [
            {
               "items": {
                  "type": "integer"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The UPC list of the product.",
         "title": "Upc List"
      },
      "gtin_list": {
         "anyOf": [
            {
               "items": {
                  "type": "integer"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The GTIN list of the product.",
         "title": "Gtin List"
      },
      "variant_reviews": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The variant reviews of the product.",
         "title": "Variant Reviews"
      },
      "updated_at": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The date the product was last updated.",
         "title": "Updated At"
      },
      "subcategory_ranks": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/ProductDatabaseSubcategoryRanks"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The subcategory ranks of the product.",
         "title": "Subcategory Ranks"
      },
      "fee_breakdown": {
         "anyOf": [
            {
               "$ref": "#/$defs/ProductDatabaseFeeBreakdown"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The fee breakdown of the product."
      }
   },
   "$defs": {
      "ProductDatabaseFeeBreakdown": {
         "description": "Represents a response object containing fee breakdown.",
         "properties": {
            "fba_fee": {
               "description": "The FBA fee of the product.",
               "title": "Fba Fee",
               "type": "number"
            },
            "referral_fee": {
               "description": "The referral fee of the product.",
               "title": "Referral Fee",
               "type": "number"
            },
            "variable_closing_fee": {
               "description": "The variable closing fee of the product.",
               "title": "Variable Closing Fee",
               "type": "number"
            },
            "total_fees": {
               "description": "The total fees of the product.",
               "title": "Total Fees",
               "type": "number"
            }
         },
         "required": [
            "fba_fee",
            "referral_fee",
            "variable_closing_fee",
            "total_fees"
         ],
         "title": "ProductDatabaseFeeBreakdown",
         "type": "object"
      },
      "ProductDatabaseSubcategoryRanks": {
         "description": "Represents a response object containing subcategory ranks.",
         "properties": {
            "subcategory": {
               "description": "The subcategory of the product.",
               "title": "Subcategory",
               "type": "string"
            },
            "rank": {
               "description": "The rank of the product.",
               "title": "Rank",
               "type": "integer"
            }
         },
         "required": [
            "subcategory",
            "rank"
         ],
         "title": "ProductDatabaseSubcategoryRanks",
         "type": "object"
      }
   },
   "required": [
      "title",
      "updated_at"
   ]
}

Fields:

  • approximate_30_day_revenue (float | None)

  • approximate_30_day_units_sold (int | None)

  • brand (str | None)

  • buy_box_owner (str | None)

  • buy_box_owner_seller_id (str | None)

  • category (str | None)

  • date_first_available (datetime.datetime | None)

  • date_first_available_is_estimated (bool | None)

  • dimensions_unit (str | None)

  • ean_list (List[int] | None)

  • fee_breakdown (junglescout.models.responses.product_database.ProductDatabaseFeeBreakdown | None)

  • gtin_list (List[int] | None)

  • height_value (float | None)

  • image_url (str | None)

  • is_parent (bool | None)

  • is_standalone (bool | None)

  • is_variant (bool | None)

  • isbn_list (List[int] | None)

  • length_value (float | None)

  • listing_quality_score (float | None)

  • number_of_sellers (int | None)

  • parent_asin (str | None)

  • price (float | None)

  • product_rank (int | None)

  • rating (float | None)

  • reviews (int | None)

  • seller_type (str | None)

  • subcategory_ranks (List[junglescout.models.responses.product_database.ProductDatabaseSubcategoryRanks] | None)

  • title (str)

  • upc_list (List[int] | None)

  • updated_at (datetime.datetime | None)

  • variant_reviews (int | None)

  • variants (List[str] | None)

  • weight_unit (str | None)

  • weight_value (float | None)

  • width_value (float | None)

field approximate_30_day_revenue: Optional[float] = None

The approximate 30 day revenue of the product.

field approximate_30_day_units_sold: Optional[int] = None

The approximate 30 day units sold of the product.

field brand: Optional[str] = None

The brand of the product.

field buy_box_owner: Optional[str] = None

The buy box owner of the product.

field buy_box_owner_seller_id: Optional[str] = None

The buy box owner seller ID of the product.

field category: Optional[str] = None

The category of the product.

field date_first_available: Optional[datetime] = None

The date the product was first available.

field date_first_available_is_estimated: Optional[bool] = None

Whether the date the product was first available is estimated.

field dimensions_unit: Optional[str] = None

The dimensions unit of the product.

field ean_list: Optional[List[int]] = None

The EAN list of the product.

field fee_breakdown: Optional[ProductDatabaseFeeBreakdown] = None

The fee breakdown of the product.

field gtin_list: Optional[List[int]] = None

The GTIN list of the product.

field height_value: Optional[float] = None

The height value of the product.

field image_url: Optional[str] = None

The image URL of the product.

field is_parent: Optional[bool] = None

Whether the product is a parent.

field is_standalone: Optional[bool] = None

Whether the product is standalone.

field is_variant: Optional[bool] = None

Whether the product is a variant.

field isbn_list: Optional[List[int]] = None

The ISBN list of the product.

field length_value: Optional[float] = None

The length value of the product.

field listing_quality_score: Optional[float] = None

The listing quality score of the product.

field number_of_sellers: Optional[int] = None

The number of sellers for the product.

field parent_asin: Optional[str] = None

The parent ASIN of the product.

field price: Optional[float] = None

The price of the product.

field product_rank: Optional[int] = None

The rank of the product.

field rating: Optional[float] = None

The rating of the product.

field reviews: Optional[int] = None

The number of reviews for the product.

field seller_type: Optional[str] = None

The type of the seller.

field subcategory_ranks: Optional[List[ProductDatabaseSubcategoryRanks]] = None

The subcategory ranks of the product.

field title: str [Required]

The title of the product.

field upc_list: Optional[List[int]] = None

The UPC list of the product.

field updated_at: Optional[datetime] [Required]

The date the product was last updated.

field variant_reviews: Optional[int] = None

The variant reviews of the product.

field variants: Optional[List[str]] = None

The number of variants for the product.

field weight_unit: Optional[str] = None

The weight unit of the product.

field weight_value: Optional[float] = None

The weight value of the product.

field width_value: Optional[float] = None

The width value of the product.

pydantic model junglescout.models.responses.ProductDatabaseFeeBreakdown[source]

Represents a response object containing fee breakdown.

Show JSON schema
{
   "title": "ProductDatabaseFeeBreakdown",
   "description": "Represents a response object containing fee breakdown.",
   "type": "object",
   "properties": {
      "fba_fee": {
         "description": "The FBA fee of the product.",
         "title": "Fba Fee",
         "type": "number"
      },
      "referral_fee": {
         "description": "The referral fee of the product.",
         "title": "Referral Fee",
         "type": "number"
      },
      "variable_closing_fee": {
         "description": "The variable closing fee of the product.",
         "title": "Variable Closing Fee",
         "type": "number"
      },
      "total_fees": {
         "description": "The total fees of the product.",
         "title": "Total Fees",
         "type": "number"
      }
   },
   "required": [
      "fba_fee",
      "referral_fee",
      "variable_closing_fee",
      "total_fees"
   ]
}

Fields:

  • fba_fee (float)

  • referral_fee (float)

  • total_fees (float)

  • variable_closing_fee (float)

field fba_fee: float [Required]

The FBA fee of the product.

field referral_fee: float [Required]

The referral fee of the product.

field total_fees: float [Required]

The total fees of the product.

field variable_closing_fee: float [Required]

The variable closing fee of the product.

pydantic model junglescout.models.responses.ProductDatabaseSubcategoryRanks[source]

Represents a response object containing subcategory ranks.

Show JSON schema
{
   "title": "ProductDatabaseSubcategoryRanks",
   "description": "Represents a response object containing subcategory ranks.",
   "type": "object",
   "properties": {
      "subcategory": {
         "description": "The subcategory of the product.",
         "title": "Subcategory",
         "type": "string"
      },
      "rank": {
         "description": "The rank of the product.",
         "title": "Rank",
         "type": "integer"
      }
   },
   "required": [
      "subcategory",
      "rank"
   ]
}

Fields:

  • rank (int)

  • subcategory (str)

field rank: int [Required]

The rank of the product.

field subcategory: str [Required]

The subcategory of the product.

pydantic model junglescout.models.responses.SalesEstimateAttributes[source]

The attributes of the sales estimate.

Show JSON schema
{
   "title": "SalesEstimateAttributes",
   "description": "The attributes of the sales estimate.",
   "type": "object",
   "properties": {
      "asin": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ASIN (Amazon Standard Identification Number) associated with the sales estimate.",
         "title": "Asin"
      },
      "is_parent": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A boolean indicating whether the ASIN is a parent ASIN.",
         "title": "Is Parent"
      },
      "is_variant": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A boolean indicating whether the ASIN is a variant.",
         "title": "Is Variant"
      },
      "is_standalone": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A boolean indicating whether the ASIN is a standalone product.",
         "title": "Is Standalone"
      },
      "parent_asin": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The parent ASIN associated with the sales estimate.",
         "title": "Parent Asin"
      },
      "variants": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The variant ASINs associated with the sales estimate.",
         "title": "Variants"
      },
      "data": {
         "description": "The sales estimate data.",
         "items": {
            "$ref": "#/$defs/SalesEstimateData"
         },
         "title": "Data",
         "type": "array"
      }
   },
   "$defs": {
      "SalesEstimateData": {
         "description": "Represents sales estimates data.",
         "properties": {
            "date": {
               "description": "The date of the sales estimate.",
               "format": "date-time",
               "title": "Date",
               "type": "string"
            },
            "estimated_units_sold": {
               "description": "The estimated units sold.",
               "title": "Estimated Units Sold",
               "type": "integer"
            },
            "last_known_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The last known price.",
               "title": "Last Known Price"
            }
         },
         "required": [
            "date",
            "estimated_units_sold"
         ],
         "title": "SalesEstimateData",
         "type": "object"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

  • asin (str | None)

  • data (List[junglescout.models.responses.sales_estimates.SalesEstimateData])

  • is_parent (bool | None)

  • is_standalone (bool | None)

  • is_variant (bool | None)

  • parent_asin (str | None)

  • variants (List[str] | None)

field asin: Optional[str] = None

The ASIN (Amazon Standard Identification Number) associated with the sales estimate.

field data: List[SalesEstimateData] [Required]

The sales estimate data.

field is_parent: Optional[bool] = None

A boolean indicating whether the ASIN is a parent ASIN.

field is_standalone: Optional[bool] = None

A boolean indicating whether the ASIN is a standalone product.

field is_variant: Optional[bool] = None

A boolean indicating whether the ASIN is a variant.

field parent_asin: Optional[str] = None

The parent ASIN associated with the sales estimate.

field variants: Optional[List[str]] = None

The variant ASINs associated with the sales estimate.

pydantic model junglescout.models.responses.SalesEstimateData[source]

Represents sales estimates data.

Show JSON schema
{
   "title": "SalesEstimateData",
   "description": "Represents sales estimates data.",
   "type": "object",
   "properties": {
      "date": {
         "description": "The date of the sales estimate.",
         "format": "date-time",
         "title": "Date",
         "type": "string"
      },
      "estimated_units_sold": {
         "description": "The estimated units sold.",
         "title": "Estimated Units Sold",
         "type": "integer"
      },
      "last_known_price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The last known price.",
         "title": "Last Known Price"
      }
   },
   "required": [
      "date",
      "estimated_units_sold"
   ]
}

Fields:

  • date (datetime.datetime)

  • estimated_units_sold (int)

  • last_known_price (float | None)

field date: datetime [Required]

The date of the sales estimate.

field estimated_units_sold: int [Required]

The estimated units sold.

field last_known_price: Optional[float] = None

The last known price.

pydantic model junglescout.models.responses.SalesEstimates[source]

Represents a list of sales estimates.

Show JSON schema
{
   "title": "SalesEstimates",
   "description": "Represents a list of sales estimates.",
   "type": "object",
   "properties": {
      "id": {
         "description": "The ID of the sales estimate.",
         "title": "Id",
         "type": "string"
      },
      "type": {
         "description": "The type of the sales estimate.",
         "title": "Type",
         "type": "string"
      },
      "attributes": {
         "$ref": "#/$defs/SalesEstimateAttributes"
      }
   },
   "$defs": {
      "SalesEstimateAttributes": {
         "description": "The attributes of the sales estimate.",
         "properties": {
            "asin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ASIN (Amazon Standard Identification Number) associated with the sales estimate.",
               "title": "Asin"
            },
            "is_parent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A boolean indicating whether the ASIN is a parent ASIN.",
               "title": "Is Parent"
            },
            "is_variant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A boolean indicating whether the ASIN is a variant.",
               "title": "Is Variant"
            },
            "is_standalone": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A boolean indicating whether the ASIN is a standalone product.",
               "title": "Is Standalone"
            },
            "parent_asin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent ASIN associated with the sales estimate.",
               "title": "Parent Asin"
            },
            "variants": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The variant ASINs associated with the sales estimate.",
               "title": "Variants"
            },
            "data": {
               "description": "The sales estimate data.",
               "items": {
                  "$ref": "#/$defs/SalesEstimateData"
               },
               "title": "Data",
               "type": "array"
            }
         },
         "required": [
            "data"
         ],
         "title": "SalesEstimateAttributes",
         "type": "object"
      },
      "SalesEstimateData": {
         "description": "Represents sales estimates data.",
         "properties": {
            "date": {
               "description": "The date of the sales estimate.",
               "format": "date-time",
               "title": "Date",
               "type": "string"
            },
            "estimated_units_sold": {
               "description": "The estimated units sold.",
               "title": "Estimated Units Sold",
               "type": "integer"
            },
            "last_known_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The last known price.",
               "title": "Last Known Price"
            }
         },
         "required": [
            "date",
            "estimated_units_sold"
         ],
         "title": "SalesEstimateData",
         "type": "object"
      }
   },
   "required": [
      "id",
      "type",
      "attributes"
   ]
}

Fields:

  • attributes (junglescout.models.responses.sales_estimates.SalesEstimateAttributes)

  • id (str)

  • type (str)

field attributes: SalesEstimateAttributes [Required]

The attributes of the sales estimate.

field id: str [Required]

The ID of the sales estimate.

field type: str [Required]

The type of the sales estimate.

pydantic model junglescout.models.responses.ShareOfVoice[source]

Represents the Share of Voice response from the Jungle Scout API.

Show JSON schema
{
   "title": "ShareOfVoice",
   "description": "Represents the Share of Voice response from the Jungle Scout API.",
   "type": "object",
   "properties": {
      "type": {
         "description": "The type of the Share of Voice response.",
         "title": "Type",
         "type": "string"
      },
      "id": {
         "description": "The ID of the Share of Voice response.",
         "title": "Id",
         "type": "string"
      },
      "attributes": {
         "allOf": [
            {
               "$ref": "#/$defs/ShareOfVoiceAttributes"
            }
         ],
         "description": "The attributes of the Share of Voice response."
      }
   },
   "$defs": {
      "ShareOfVoiceAttributes": {
         "description": "Attributes for the Share of Voice response.",
         "properties": {
            "estimated_30_day_search_volume": {
               "description": "The estimated 30-day search volume.",
               "title": "Estimated 30 Day Search Volume",
               "type": "integer"
            },
            "exact_suggested_bid_median": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The median of the exact suggested bid.",
               "title": "Exact Suggested Bid Median"
            },
            "product_count": {
               "description": "The count of products.",
               "title": "Product Count",
               "type": "integer"
            },
            "updated_at": {
               "description": "The date and time when the Share of Voice data was last updated.",
               "format": "date-time",
               "title": "Updated At",
               "type": "string"
            },
            "brands": {
               "description": "The brands associated with the Share of Voice data.",
               "items": {
                  "$ref": "#/$defs/ShareOfVoiceBrands"
               },
               "title": "Brands",
               "type": "array"
            },
            "top_asins": {
               "description": "The top ASINs associated with the Share of Voice data.",
               "items": {
                  "$ref": "#/$defs/ShareOfVoiceTopAsins"
               },
               "title": "Top Asins",
               "type": "array"
            },
            "top_asins_model_start_date": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The start date of the top ASINs model.",
               "title": "Top Asins Model Start Date"
            },
            "top_asins_model_end_date": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The end date of the top ASINs model.",
               "title": "Top Asins Model End Date"
            }
         },
         "required": [
            "estimated_30_day_search_volume",
            "product_count",
            "updated_at",
            "brands",
            "top_asins",
            "top_asins_model_start_date",
            "top_asins_model_end_date"
         ],
         "title": "ShareOfVoiceAttributes",
         "type": "object"
      },
      "ShareOfVoiceBrands": {
         "description": "Represents a list of brands in the Share of Voice response.",
         "properties": {
            "brand": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the brand.",
               "title": "Brand"
            },
            "combined_products": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The count of combined products.",
               "title": "Combined Products"
            },
            "combined_weighted_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined weighted share of voice.",
               "title": "Combined Weighted Sov"
            },
            "combined_basic_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined basic share of voice.",
               "title": "Combined Basic Sov"
            },
            "combined_average_position": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined average position.",
               "title": "Combined Average Position"
            },
            "combined_average_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined average price.",
               "title": "Combined Average Price"
            },
            "organic_products": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic products.",
               "title": "Organic Products"
            },
            "organic_weighted_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic weighted share of voice.",
               "title": "Organic Weighted Sov"
            },
            "organic_basic_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic basic share of voice.",
               "title": "Organic Basic Sov"
            },
            "organic_average_position": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic average position.",
               "title": "Organic Average Position"
            },
            "organic_average_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic average price.",
               "title": "Organic Average Price"
            },
            "sponsored_products": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored products.",
               "title": "Sponsored Products"
            },
            "sponsored_weighted_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored weighted share of voice.",
               "title": "Sponsored Weighted Sov"
            },
            "sponsored_basic_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored basic share of voice.",
               "title": "Sponsored Basic Sov"
            },
            "sponsored_average_position": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored average position.",
               "title": "Sponsored Average Position"
            },
            "sponsored_average_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored average price.",
               "title": "Sponsored Average Price"
            }
         },
         "title": "ShareOfVoiceBrands",
         "type": "object"
      },
      "ShareOfVoiceTopAsins": {
         "description": "Represents a list of top ASINs in the Share of Voice response.",
         "properties": {
            "asin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ASIN.",
               "title": "Asin"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name.",
               "title": "Name"
            },
            "brand": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The brand.",
               "title": "Brand"
            },
            "clicks": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The clicks.",
               "title": "Clicks"
            },
            "conversions": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The conversions.",
               "title": "Conversions"
            },
            "conversion_rate": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The conversion rate.",
               "title": "Conversion Rate"
            }
         },
         "title": "ShareOfVoiceTopAsins",
         "type": "object"
      }
   },
   "required": [
      "type",
      "id",
      "attributes"
   ]
}

Fields:

  • attributes (junglescout.models.responses.share_of_voice.ShareOfVoiceAttributes)

  • id (str)

  • type (str)

field attributes: ShareOfVoiceAttributes [Required]

The attributes of the Share of Voice response.

field id: str [Required]

The ID of the Share of Voice response.

field type: str [Required]

The type of the Share of Voice response.

pydantic model junglescout.models.responses.ShareOfVoiceAttributes[source]

Attributes for the Share of Voice response.

Show JSON schema
{
   "title": "ShareOfVoiceAttributes",
   "description": "Attributes for the Share of Voice response.",
   "type": "object",
   "properties": {
      "estimated_30_day_search_volume": {
         "description": "The estimated 30-day search volume.",
         "title": "Estimated 30 Day Search Volume",
         "type": "integer"
      },
      "exact_suggested_bid_median": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The median of the exact suggested bid.",
         "title": "Exact Suggested Bid Median"
      },
      "product_count": {
         "description": "The count of products.",
         "title": "Product Count",
         "type": "integer"
      },
      "updated_at": {
         "description": "The date and time when the Share of Voice data was last updated.",
         "format": "date-time",
         "title": "Updated At",
         "type": "string"
      },
      "brands": {
         "description": "The brands associated with the Share of Voice data.",
         "items": {
            "$ref": "#/$defs/ShareOfVoiceBrands"
         },
         "title": "Brands",
         "type": "array"
      },
      "top_asins": {
         "description": "The top ASINs associated with the Share of Voice data.",
         "items": {
            "$ref": "#/$defs/ShareOfVoiceTopAsins"
         },
         "title": "Top Asins",
         "type": "array"
      },
      "top_asins_model_start_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The start date of the top ASINs model.",
         "title": "Top Asins Model Start Date"
      },
      "top_asins_model_end_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The end date of the top ASINs model.",
         "title": "Top Asins Model End Date"
      }
   },
   "$defs": {
      "ShareOfVoiceBrands": {
         "description": "Represents a list of brands in the Share of Voice response.",
         "properties": {
            "brand": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the brand.",
               "title": "Brand"
            },
            "combined_products": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The count of combined products.",
               "title": "Combined Products"
            },
            "combined_weighted_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined weighted share of voice.",
               "title": "Combined Weighted Sov"
            },
            "combined_basic_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined basic share of voice.",
               "title": "Combined Basic Sov"
            },
            "combined_average_position": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined average position.",
               "title": "Combined Average Position"
            },
            "combined_average_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The combined average price.",
               "title": "Combined Average Price"
            },
            "organic_products": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic products.",
               "title": "Organic Products"
            },
            "organic_weighted_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic weighted share of voice.",
               "title": "Organic Weighted Sov"
            },
            "organic_basic_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic basic share of voice.",
               "title": "Organic Basic Sov"
            },
            "organic_average_position": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic average position.",
               "title": "Organic Average Position"
            },
            "organic_average_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The organic average price.",
               "title": "Organic Average Price"
            },
            "sponsored_products": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored products.",
               "title": "Sponsored Products"
            },
            "sponsored_weighted_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored weighted share of voice.",
               "title": "Sponsored Weighted Sov"
            },
            "sponsored_basic_sov": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored basic share of voice.",
               "title": "Sponsored Basic Sov"
            },
            "sponsored_average_position": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored average position.",
               "title": "Sponsored Average Position"
            },
            "sponsored_average_price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sponsored average price.",
               "title": "Sponsored Average Price"
            }
         },
         "title": "ShareOfVoiceBrands",
         "type": "object"
      },
      "ShareOfVoiceTopAsins": {
         "description": "Represents a list of top ASINs in the Share of Voice response.",
         "properties": {
            "asin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ASIN.",
               "title": "Asin"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name.",
               "title": "Name"
            },
            "brand": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The brand.",
               "title": "Brand"
            },
            "clicks": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The clicks.",
               "title": "Clicks"
            },
            "conversions": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The conversions.",
               "title": "Conversions"
            },
            "conversion_rate": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The conversion rate.",
               "title": "Conversion Rate"
            }
         },
         "title": "ShareOfVoiceTopAsins",
         "type": "object"
      }
   },
   "required": [
      "estimated_30_day_search_volume",
      "product_count",
      "updated_at",
      "brands",
      "top_asins",
      "top_asins_model_start_date",
      "top_asins_model_end_date"
   ]
}

Fields:

  • brands (List[junglescout.models.responses.share_of_voice.ShareOfVoiceBrands])

  • estimated_30_day_search_volume (int)

  • exact_suggested_bid_median (float | None)

  • product_count (int)

  • top_asins (List[junglescout.models.responses.share_of_voice.ShareOfVoiceTopAsins])

  • top_asins_model_end_date (datetime.datetime | None)

  • top_asins_model_start_date (datetime.datetime | None)

  • updated_at (datetime.datetime)

field brands: List[ShareOfVoiceBrands] [Required]

The brands associated with the Share of Voice data.

field estimated_30_day_search_volume: int [Required]

The estimated 30-day search volume.

field exact_suggested_bid_median: Optional[float] = None

The median of the exact suggested bid.

field product_count: int [Required]

The count of products.

field top_asins: List[ShareOfVoiceTopAsins] [Required]

The top ASINs associated with the Share of Voice data.

field top_asins_model_end_date: Optional[datetime] [Required]

The end date of the top ASINs model.

field top_asins_model_start_date: Optional[datetime] [Required]

The start date of the top ASINs model.

field updated_at: datetime [Required]

The date and time when the Share of Voice data was last updated.

pydantic model junglescout.models.responses.ShareOfVoiceBrands[source]

Represents a list of brands in the Share of Voice response.

Show JSON schema
{
   "title": "ShareOfVoiceBrands",
   "description": "Represents a list of brands in the Share of Voice response.",
   "type": "object",
   "properties": {
      "brand": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the brand.",
         "title": "Brand"
      },
      "combined_products": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The count of combined products.",
         "title": "Combined Products"
      },
      "combined_weighted_sov": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The combined weighted share of voice.",
         "title": "Combined Weighted Sov"
      },
      "combined_basic_sov": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The combined basic share of voice.",
         "title": "Combined Basic Sov"
      },
      "combined_average_position": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The combined average position.",
         "title": "Combined Average Position"
      },
      "combined_average_price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The combined average price.",
         "title": "Combined Average Price"
      },
      "organic_products": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic products.",
         "title": "Organic Products"
      },
      "organic_weighted_sov": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic weighted share of voice.",
         "title": "Organic Weighted Sov"
      },
      "organic_basic_sov": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic basic share of voice.",
         "title": "Organic Basic Sov"
      },
      "organic_average_position": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic average position.",
         "title": "Organic Average Position"
      },
      "organic_average_price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The organic average price.",
         "title": "Organic Average Price"
      },
      "sponsored_products": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored products.",
         "title": "Sponsored Products"
      },
      "sponsored_weighted_sov": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored weighted share of voice.",
         "title": "Sponsored Weighted Sov"
      },
      "sponsored_basic_sov": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored basic share of voice.",
         "title": "Sponsored Basic Sov"
      },
      "sponsored_average_position": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored average position.",
         "title": "Sponsored Average Position"
      },
      "sponsored_average_price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sponsored average price.",
         "title": "Sponsored Average Price"
      }
   }
}

Fields:

  • brand (str | None)

  • combined_average_position (float | None)

  • combined_average_price (float | None)

  • combined_basic_sov (float | None)

  • combined_products (int | None)

  • combined_weighted_sov (float | None)

  • organic_average_position (float | None)

  • organic_average_price (float | None)

  • organic_basic_sov (float | None)

  • organic_products (int | None)

  • organic_weighted_sov (float | None)

  • sponsored_average_position (float | None)

  • sponsored_average_price (float | None)

  • sponsored_basic_sov (float | None)

  • sponsored_products (int | None)

  • sponsored_weighted_sov (float | None)

field brand: Optional[str] = None

The name of the brand.

field combined_average_position: Optional[float] = None

The combined average position.

field combined_average_price: Optional[float] = None

The combined average price.

field combined_basic_sov: Optional[float] = None

The combined basic share of voice.

field combined_products: Optional[int] = None

The count of combined products.

field combined_weighted_sov: Optional[float] = None

The combined weighted share of voice.

field organic_average_position: Optional[float] = None

The organic average position.

field organic_average_price: Optional[float] = None

The organic average price.

field organic_basic_sov: Optional[float] = None

The organic basic share of voice.

field organic_products: Optional[int] = None

The organic products.

field organic_weighted_sov: Optional[float] = None

The organic weighted share of voice.

field sponsored_average_position: Optional[float] = None

The sponsored average position.

field sponsored_average_price: Optional[float] = None

The sponsored average price.

field sponsored_basic_sov: Optional[float] = None

The sponsored basic share of voice.

field sponsored_products: Optional[int] = None

The sponsored products.

field sponsored_weighted_sov: Optional[float] = None

The sponsored weighted share of voice.

pydantic model junglescout.models.responses.ShareOfVoiceTopAsins[source]

Represents a list of top ASINs in the Share of Voice response.

Show JSON schema
{
   "title": "ShareOfVoiceTopAsins",
   "description": "Represents a list of top ASINs in the Share of Voice response.",
   "type": "object",
   "properties": {
      "asin": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ASIN.",
         "title": "Asin"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name.",
         "title": "Name"
      },
      "brand": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The brand.",
         "title": "Brand"
      },
      "clicks": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The clicks.",
         "title": "Clicks"
      },
      "conversions": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The conversions.",
         "title": "Conversions"
      },
      "conversion_rate": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The conversion rate.",
         "title": "Conversion Rate"
      }
   }
}

Fields:

  • asin (str | None)

  • brand (str | None)

  • clicks (int | None)

  • conversion_rate (float | None)

  • conversions (int | None)

  • name (str | None)

field asin: Optional[str] = None

The ASIN.

field brand: Optional[str] = None

The brand.

field clicks: Optional[int] = None

The clicks.

field conversion_rate: Optional[float] = None

The conversion rate.

field conversions: Optional[int] = None

The conversions.

field name: Optional[str] = None

The name.

Exceptions

References for the exceptions raised by the Jungle Scout API.

exception junglescout.exceptions.JungleScoutError[source]

Base exception for all Jungle Scout Client Exceptions.

exception junglescout.exceptions.JungleScoutHTTPError(message, httpx_exception)[source]

Base exception for Jungle Scout Client HTTP errors.