junglescout-client 0.1.3

Jungle Scout API Client

Jungle Scout Python Client

The official Jungle Scout API Python Client. Documentation for this client is available on Read the Docs.

See the Jungle Scout API Documentation and the Jungle Scout Postman Collection for more information about the Jungle Scout API.

Installation

pip install junglescout-client

Usage

This client is designed to be simple and easy to use. Here's a quick example of how to use the client to get keywords by ASIN:

from junglescout.client import Client
from junglescout.models.parameters import Marketplace, ApiType, FilterOptions, Sort

API_KEY_NAME = "api_key_name"
API_KEY = "api_key"

client = Client(
    api_key_name=API_KEY_NAME,
    api_key=API_KEY,
    marketplace=Marketplace.US,
    api_type=ApiType.JS
)

filter_options = FilterOptions(min_monthly_search_volume_exact=150)

keywords = client.keywords_by_asin(
    asin='B005IHSKYS',
    filter_options=filter_options,
    sort_option=Sort.MONTHLY_SEARCH_VOLUME_EXACT_MATCH
)

All the API methods are available from the Client class. See the documentation for complete API reference information.

Pydantic Models

This project defines API model objects using Pydantic. Autocomplete for model parameters during instantiation should work by default in most modern IDEs. For Jetbrains IDEs, the Pydantic plugin is required for autocomplete. See the following links for more information:

• pydantic/pull/2721
• pydantic/issues/650

Contributing

Contributions are welcome! Please read the contributing guidelines for more information.