KeywordsDataApi.md

root / docs

[Back to README.md]

dataforseo_client.KeywordsDataApi

All URIs are relative to https://api.dataforseo.com

Method	HTTP request	Description
bing_keyword_performance_live	POST /v3/keywords_data/bing/keyword_performance/live
bing_keyword_performance_task_get	GET /v3/keywords_data/bing/keyword_performance/task_get/{id}
bing_keyword_performance_task_post	POST /v3/keywords_data/bing/keyword_performance/task_post
bing_keyword_performance_tasks_ready	GET /v3/keywords_data/bing/keyword_performance/tasks_ready
bing_keywords_for_keywords_live	POST /v3/keywords_data/bing/keywords_for_keywords/live
bing_keywords_for_keywords_task_get	GET /v3/keywords_data/bing/keywords_for_keywords/task_get/{id}
bing_keywords_for_keywords_task_post	POST /v3/keywords_data/bing/keywords_for_keywords/task_post
bing_keywords_for_keywords_tasks_ready	GET /v3/keywords_data/bing/keywords_for_keywords/tasks_ready
bing_keywords_for_site_live	POST /v3/keywords_data/bing/keywords_for_site/live
bing_keywords_for_site_task_get	GET /v3/keywords_data/bing/keywords_for_site/task_get/{id}
bing_keywords_for_site_task_post	POST /v3/keywords_data/bing/keywords_for_site/task_post
bing_keywords_for_site_tasks_ready	GET /v3/keywords_data/bing/keywords_for_site/tasks_ready
bing_search_volume_live	POST /v3/keywords_data/bing/search_volume/live
bing_search_volume_task_get	GET /v3/keywords_data/bing/search_volume/task_get/{id}
bing_search_volume_task_post	POST /v3/keywords_data/bing/search_volume/task_post
bing_search_volume_tasks_ready	GET /v3/keywords_data/bing/search_volume/tasks_ready
google_ads_ad_traffic_by_keywords_live	POST /v3/keywords_data/google_ads/ad_traffic_by_keywords/live
google_ads_ad_traffic_by_keywords_task_get	GET /v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/{id}
google_ads_ad_traffic_by_keywords_task_post	POST /v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post
google_ads_ad_traffic_by_keywords_tasks_ready	GET /v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready
google_ads_keywords_for_keywords_live	POST /v3/keywords_data/google_ads/keywords_for_keywords/live
google_ads_keywords_for_keywords_task_get	GET /v3/keywords_data/google_ads/keywords_for_keywords/task_get/{id}
google_ads_keywords_for_keywords_task_post	POST /v3/keywords_data/google_ads/keywords_for_keywords/task_post
google_ads_keywords_for_keywords_tasks_ready	GET /v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready
google_ads_keywords_for_site_live	POST /v3/keywords_data/google_ads/keywords_for_site/live
google_ads_keywords_for_site_task_get	GET /v3/keywords_data/google_ads/keywords_for_site/task_get/{id}
google_ads_keywords_for_site_task_post	POST /v3/keywords_data/google_ads/keywords_for_site/task_post
google_ads_keywords_for_site_tasks_ready	GET /v3/keywords_data/google_ads/keywords_for_site/tasks_ready
google_ads_search_volume_live	POST /v3/keywords_data/google_ads/search_volume/live
google_ads_search_volume_task_get	GET /v3/keywords_data/google_ads/search_volume/task_get/{id}
google_ads_search_volume_task_post	POST /v3/keywords_data/google_ads/search_volume/task_post
google_ads_search_volume_tasks_ready	GET /v3/keywords_data/google_ads/search_volume/tasks_ready
google_ads_status	GET /v3/keywords_data/google_ads/status
google_trends_categories	GET /v3/keywords_data/google_trends/categories
google_trends_explore_live	POST /v3/keywords_data/google_trends/explore/live
google_trends_explore_task_get	GET /v3/keywords_data/google_trends/explore/task_get/{id}
google_trends_explore_task_post	POST /v3/keywords_data/google_trends/explore/task_post
google_trends_explore_tasks_ready	GET /v3/keywords_data/google_trends/explore/tasks_ready
keywords_data_bing_keyword_performance_locations_and_languages	GET /v3/keywords_data/bing/keyword_performance/locations_and_languages
keywords_data_bing_languages	GET /v3/keywords_data/bing/languages
keywords_data_bing_locations	GET /v3/keywords_data/bing/locations
keywords_data_errors	POST /v3/keywords_data/errors
keywords_data_google_ads_languages	GET /v3/keywords_data/google_ads/languages
keywords_data_google_ads_locations	GET /v3/keywords_data/google_ads/locations
keywords_data_google_trends_languages	GET /v3/keywords_data/google_trends/languages
keywords_data_google_trends_locations	GET /v3/keywords_data/google_trends/locations
keywords_data_google_trends_locations_country	GET /v3/keywords_data/google_trends/locations/{country}
keywords_data_id_list	POST /v3/keywords_data/id_list

bing_keyword_performance_live

KeywordsDataBingKeywordPerformanceLiveResponseInfo bing_keyword_performance_live(keywords_data_bing_keyword_performance_live_request_info=keywords_data_bing_keyword_performance_live_request_info)

‌ You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keyword_performance_live_request_info import KeywordsDataBingKeywordPerformanceLiveRequestInfo
from dataforseo_client.models.keywords_data_bing_keyword_performance_live_response_info import KeywordsDataBingKeywordPerformanceLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_keyword_performance_live_request_info = [dataforseo_client.KeywordsDataBingKeywordPerformanceLiveRequestInfo()] # List[KeywordsDataBingKeywordPerformanceLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_keyword_performance_live(keywords_data_bing_keyword_performance_live_request_info=keywords_data_bing_keyword_performance_live_request_info)
        print("The response of KeywordsDataApi->bing_keyword_performance_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keyword_performance_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_keyword_performance_live_request_info	List[KeywordsDataBingKeywordPerformanceLiveRequestInfo]		[optional]

Return type

KeywordsDataBingKeywordPerformanceLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keyword_performance_task_get

KeywordsDataBingKeywordPerformanceTaskGetResponseInfo bing_keyword_performance_task_get(id)

‌ You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keyword_performance_task_get_response_info import KeywordsDataBingKeywordPerformanceTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = '2dbc8bcb-082b-441b-bee5-1de473c94a63' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.bing_keyword_performance_task_get(id)
        print("The response of KeywordsDataApi->bing_keyword_performance_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keyword_performance_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataBingKeywordPerformanceTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keyword_performance_task_post

KeywordsDataBingKeywordPerformanceTaskPostResponseInfo bing_keyword_performance_task_post(keywords_data_bing_keyword_performance_task_post_request_info=keywords_data_bing_keyword_performance_task_post_request_info)

‌ You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keyword_performance_task_post_request_info import KeywordsDataBingKeywordPerformanceTaskPostRequestInfo
from dataforseo_client.models.keywords_data_bing_keyword_performance_task_post_response_info import KeywordsDataBingKeywordPerformanceTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_keyword_performance_task_post_request_info = [dataforseo_client.KeywordsDataBingKeywordPerformanceTaskPostRequestInfo()] # List[KeywordsDataBingKeywordPerformanceTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_keyword_performance_task_post(keywords_data_bing_keyword_performance_task_post_request_info=keywords_data_bing_keyword_performance_task_post_request_info)
        print("The response of KeywordsDataApi->bing_keyword_performance_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keyword_performance_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_keyword_performance_task_post_request_info	List[KeywordsDataBingKeywordPerformanceTaskPostRequestInfo]		[optional]

Return type

KeywordsDataBingKeywordPerformanceTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keyword_performance_tasks_ready

KeywordsDataBingKeywordPerformanceTasksReadyResponseInfo bing_keyword_performance_tasks_ready()

‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keyword_performance_tasks_ready_response_info import KeywordsDataBingKeywordPerformanceTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.bing_keyword_performance_tasks_ready()
        print("The response of KeywordsDataApi->bing_keyword_performance_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keyword_performance_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingKeywordPerformanceTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_keywords_live

KeywordsDataBingKeywordsForKeywordsLiveResponseInfo bing_keywords_for_keywords_live(keywords_data_bing_keywords_for_keywords_live_request_info=keywords_data_bing_keywords_for_keywords_live_request_info)

‌ This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_keywords_live_request_info import KeywordsDataBingKeywordsForKeywordsLiveRequestInfo
from dataforseo_client.models.keywords_data_bing_keywords_for_keywords_live_response_info import KeywordsDataBingKeywordsForKeywordsLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_keywords_for_keywords_live_request_info = [dataforseo_client.KeywordsDataBingKeywordsForKeywordsLiveRequestInfo()] # List[KeywordsDataBingKeywordsForKeywordsLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_keywords_for_keywords_live(keywords_data_bing_keywords_for_keywords_live_request_info=keywords_data_bing_keywords_for_keywords_live_request_info)
        print("The response of KeywordsDataApi->bing_keywords_for_keywords_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_keywords_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_keywords_for_keywords_live_request_info	List[KeywordsDataBingKeywordsForKeywordsLiveRequestInfo]		[optional]

Return type

KeywordsDataBingKeywordsForKeywordsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_keywords_task_get

KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo bing_keywords_for_keywords_task_get(id)

‌ This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_keywords_task_get_response_info import KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = 'ac302d47-b774-4dc3-a86e-f28bbeb88435' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.bing_keywords_for_keywords_task_get(id)
        print("The response of KeywordsDataApi->bing_keywords_for_keywords_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_keywords_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_keywords_task_post

KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo bing_keywords_for_keywords_task_post(keywords_data_bing_keywords_for_keywords_task_post_request_info=keywords_data_bing_keywords_for_keywords_task_post_request_info)

‌‌ This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_keywords_task_post_request_info import KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo
from dataforseo_client.models.keywords_data_bing_keywords_for_keywords_task_post_response_info import KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_keywords_for_keywords_task_post_request_info = [dataforseo_client.KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo()] # List[KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_keywords_for_keywords_task_post(keywords_data_bing_keywords_for_keywords_task_post_request_info=keywords_data_bing_keywords_for_keywords_task_post_request_info)
        print("The response of KeywordsDataApi->bing_keywords_for_keywords_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_keywords_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_keywords_for_keywords_task_post_request_info	List[KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo]		[optional]

Return type

KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_keywords_tasks_ready

KeywordsDataBingKeywordsForKeywordsTasksReadyResponseInfo bing_keywords_for_keywords_tasks_ready()

‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_keywords_tasks_ready_response_info import KeywordsDataBingKeywordsForKeywordsTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.bing_keywords_for_keywords_tasks_ready()
        print("The response of KeywordsDataApi->bing_keywords_for_keywords_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_keywords_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingKeywordsForKeywordsTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_site_live

KeywordsDataBingKeywordsForSiteLiveResponseInfo bing_keywords_for_site_live(keywords_data_bing_keywords_for_site_live_request_info=keywords_data_bing_keywords_for_site_live_request_info)

‌This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_site_live_request_info import KeywordsDataBingKeywordsForSiteLiveRequestInfo
from dataforseo_client.models.keywords_data_bing_keywords_for_site_live_response_info import KeywordsDataBingKeywordsForSiteLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_keywords_for_site_live_request_info = [dataforseo_client.KeywordsDataBingKeywordsForSiteLiveRequestInfo()] # List[KeywordsDataBingKeywordsForSiteLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_keywords_for_site_live(keywords_data_bing_keywords_for_site_live_request_info=keywords_data_bing_keywords_for_site_live_request_info)
        print("The response of KeywordsDataApi->bing_keywords_for_site_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_site_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_keywords_for_site_live_request_info	List[KeywordsDataBingKeywordsForSiteLiveRequestInfo]		[optional]

Return type

KeywordsDataBingKeywordsForSiteLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_site_task_get

KeywordsDataBingKeywordsForSiteTaskGetResponseInfo bing_keywords_for_site_task_get(id)

‌ This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for the last year (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_site_task_get_response_info import KeywordsDataBingKeywordsForSiteTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = '11d932b5-ab92-42bb-9c6f-87c0e5593052' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.bing_keywords_for_site_task_get(id)
        print("The response of KeywordsDataApi->bing_keywords_for_site_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_site_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataBingKeywordsForSiteTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_site_task_post

KeywordsDataBingKeywordsForSiteTaskPostResponseInfo bing_keywords_for_site_task_post(keywords_data_bing_keywords_for_site_task_post_request_info=keywords_data_bing_keywords_for_site_task_post_request_info)

‌This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_site_task_post_request_info import KeywordsDataBingKeywordsForSiteTaskPostRequestInfo
from dataforseo_client.models.keywords_data_bing_keywords_for_site_task_post_response_info import KeywordsDataBingKeywordsForSiteTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_keywords_for_site_task_post_request_info = [dataforseo_client.KeywordsDataBingKeywordsForSiteTaskPostRequestInfo()] # List[KeywordsDataBingKeywordsForSiteTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_keywords_for_site_task_post(keywords_data_bing_keywords_for_site_task_post_request_info=keywords_data_bing_keywords_for_site_task_post_request_info)
        print("The response of KeywordsDataApi->bing_keywords_for_site_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_site_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_keywords_for_site_task_post_request_info	List[KeywordsDataBingKeywordsForSiteTaskPostRequestInfo]		[optional]

Return type

KeywordsDataBingKeywordsForSiteTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_keywords_for_site_tasks_ready

KeywordsDataBingKeywordsForSiteTasksReadyResponseInfo bing_keywords_for_site_tasks_ready()

‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keywords_for_site_tasks_ready_response_info import KeywordsDataBingKeywordsForSiteTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.bing_keywords_for_site_tasks_ready()
        print("The response of KeywordsDataApi->bing_keywords_for_site_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_keywords_for_site_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingKeywordsForSiteTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_search_volume_live

KeywordsDataBingSearchVolumeLiveResponseInfo bing_search_volume_live(keywords_data_bing_search_volume_live_request_info=keywords_data_bing_search_volume_live_request_info)

‌This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_search_volume_live_request_info import KeywordsDataBingSearchVolumeLiveRequestInfo
from dataforseo_client.models.keywords_data_bing_search_volume_live_response_info import KeywordsDataBingSearchVolumeLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_search_volume_live_request_info = [dataforseo_client.KeywordsDataBingSearchVolumeLiveRequestInfo()] # List[KeywordsDataBingSearchVolumeLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_search_volume_live(keywords_data_bing_search_volume_live_request_info=keywords_data_bing_search_volume_live_request_info)
        print("The response of KeywordsDataApi->bing_search_volume_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_search_volume_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_search_volume_live_request_info	List[KeywordsDataBingSearchVolumeLiveRequestInfo]		[optional]

Return type

KeywordsDataBingSearchVolumeLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_search_volume_task_get

KeywordsDataBingSearchVolumeTaskGetResponseInfo bing_search_volume_task_get(id)

‌ for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_search_volume_task_get_response_info import KeywordsDataBingSearchVolumeTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = '431405e5-6e7c-4418-867c-cac96e7bdce5' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.bing_search_volume_task_get(id)
        print("The response of KeywordsDataApi->bing_search_volume_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_search_volume_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataBingSearchVolumeTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_search_volume_task_post

KeywordsDataBingSearchVolumeTaskPostResponseInfo bing_search_volume_task_post(keywords_data_bing_search_volume_task_post_request_info=keywords_data_bing_search_volume_task_post_request_info)

‌ This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_search_volume_task_post_request_info import KeywordsDataBingSearchVolumeTaskPostRequestInfo
from dataforseo_client.models.keywords_data_bing_search_volume_task_post_response_info import KeywordsDataBingSearchVolumeTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_bing_search_volume_task_post_request_info = [dataforseo_client.KeywordsDataBingSearchVolumeTaskPostRequestInfo()] # List[KeywordsDataBingSearchVolumeTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.bing_search_volume_task_post(keywords_data_bing_search_volume_task_post_request_info=keywords_data_bing_search_volume_task_post_request_info)
        print("The response of KeywordsDataApi->bing_search_volume_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_search_volume_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_bing_search_volume_task_post_request_info	List[KeywordsDataBingSearchVolumeTaskPostRequestInfo]		[optional]

Return type

KeywordsDataBingSearchVolumeTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

bing_search_volume_tasks_ready

KeywordsDataBingSearchVolumeTasksReadyResponseInfo bing_search_volume_tasks_ready()

‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_search_volume_tasks_ready_response_info import KeywordsDataBingSearchVolumeTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.bing_search_volume_tasks_ready()
        print("The response of KeywordsDataApi->bing_search_volume_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->bing_search_volume_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingSearchVolumeTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_ad_traffic_by_keywords_live

KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo google_ads_ad_traffic_by_keywords_live(keywords_data_google_ads_ad_traffic_by_keywords_live_request_info=keywords_data_google_ads_ad_traffic_by_keywords_live_request_info)

for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_ad_traffic_by_keywords_live_request_info import KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo
from dataforseo_client.models.keywords_data_google_ads_ad_traffic_by_keywords_live_response_info import KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_ads_ad_traffic_by_keywords_live_request_info = [dataforseo_client.KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo()] # List[KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_ad_traffic_by_keywords_live(keywords_data_google_ads_ad_traffic_by_keywords_live_request_info=keywords_data_google_ads_ad_traffic_by_keywords_live_request_info)
        print("The response of KeywordsDataApi->google_ads_ad_traffic_by_keywords_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_ad_traffic_by_keywords_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_ads_ad_traffic_by_keywords_live_request_info	List[KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_ad_traffic_by_keywords_task_get

KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo google_ads_ad_traffic_by_keywords_task_get(id)

for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_ad_traffic_by_keywords_task_get_response_info import KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = '2cd39d67-d88c-43fd-bcb6-c0791dbb62df' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.google_ads_ad_traffic_by_keywords_task_get(id)
        print("The response of KeywordsDataApi->google_ads_ad_traffic_by_keywords_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_ad_traffic_by_keywords_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_ad_traffic_by_keywords_task_post

KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo google_ads_ad_traffic_by_keywords_task_post(keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info=keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info)

for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info import KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo
from dataforseo_client.models.keywords_data_google_ads_ad_traffic_by_keywords_task_post_response_info import KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info = [dataforseo_client.KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo()] # List[KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_ad_traffic_by_keywords_task_post(keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info=keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info)
        print("The response of KeywordsDataApi->google_ads_ad_traffic_by_keywords_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_ad_traffic_by_keywords_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_ads_ad_traffic_by_keywords_task_post_request_info	List[KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_ad_traffic_by_keywords_tasks_ready

KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResponseInfo google_ads_ad_traffic_by_keywords_tasks_ready()

‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_ad_traffic_by_keywords_tasks_ready_response_info import KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_ads_ad_traffic_by_keywords_tasks_ready()
        print("The response of KeywordsDataApi->google_ads_ad_traffic_by_keywords_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_ad_traffic_by_keywords_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_keywords_live

KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo google_ads_keywords_for_keywords_live(keywords_data_task_request_info=keywords_data_task_request_info)

Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_keywords_live_response_info import KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo
from dataforseo_client.models.keywords_data_task_request_info import KeywordsDataTaskRequestInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_task_request_info = [dataforseo_client.KeywordsDataTaskRequestInfo()] # List[KeywordsDataTaskRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_keywords_for_keywords_live(keywords_data_task_request_info=keywords_data_task_request_info)
        print("The response of KeywordsDataApi->google_ads_keywords_for_keywords_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_keywords_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_task_request_info	List[KeywordsDataTaskRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_keywords_task_get

KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo google_ads_keywords_for_keywords_task_get(id)

Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌ This endpoint will select relevant keywords for the specified terms. Set up to 20 keywords and get the results, which are suggested by Google Ads for your query. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_keywords_task_get_response_info import KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = '84f159d3-2f8a-4131-a312-496902a5308a' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.google_ads_keywords_for_keywords_task_get(id)
        print("The response of KeywordsDataApi->google_ads_keywords_for_keywords_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_keywords_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_keywords_task_post

KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo google_ads_keywords_for_keywords_task_post(keywords_data_google_ads_keywords_for_keywords_task_post_request_info=keywords_data_google_ads_keywords_for_keywords_task_post_request_info)

Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_keywords_task_post_request_info import KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo
from dataforseo_client.models.keywords_data_google_ads_keywords_for_keywords_task_post_response_info import KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_ads_keywords_for_keywords_task_post_request_info = [dataforseo_client.KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo()] # List[KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_keywords_for_keywords_task_post(keywords_data_google_ads_keywords_for_keywords_task_post_request_info=keywords_data_google_ads_keywords_for_keywords_task_post_request_info)
        print("The response of KeywordsDataApi->google_ads_keywords_for_keywords_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_keywords_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_ads_keywords_for_keywords_task_post_request_info	List[KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_keywords_tasks_ready

KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResponseInfo google_ads_keywords_for_keywords_tasks_ready()

‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_keywords_tasks_ready_response_info import KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_ads_keywords_for_keywords_tasks_ready()
        print("The response of KeywordsDataApi->google_ads_keywords_for_keywords_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_keywords_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_site_live

KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo google_ads_keywords_for_site_live(keywords_data_google_ads_keywords_for_site_live_request_info=keywords_data_google_ads_keywords_for_site_live_request_info)

Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_site_live_request_info import KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo
from dataforseo_client.models.keywords_data_google_ads_keywords_for_site_live_response_info import KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_ads_keywords_for_site_live_request_info = [dataforseo_client.KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo()] # List[KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_keywords_for_site_live(keywords_data_google_ads_keywords_for_site_live_request_info=keywords_data_google_ads_keywords_for_site_live_request_info)
        print("The response of KeywordsDataApi->google_ads_keywords_for_site_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_site_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_ads_keywords_for_site_live_request_info	List[KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_site_task_get

KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo google_ads_keywords_for_site_task_get(id)

‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_site_task_get_response_info import KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = 'c8c63b11-216f-4a7d-9f83-d3ae4d4f9511' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.google_ads_keywords_for_site_task_get(id)
        print("The response of KeywordsDataApi->google_ads_keywords_for_site_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_site_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_site_task_post

KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo google_ads_keywords_for_site_task_post(keywords_data_google_ads_keywords_for_site_task_post_request_info=keywords_data_google_ads_keywords_for_site_task_post_request_info)

‌ for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_site_task_post_request_info import KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo
from dataforseo_client.models.keywords_data_google_ads_keywords_for_site_task_post_response_info import KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_ads_keywords_for_site_task_post_request_info = [dataforseo_client.KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo()] # List[KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_keywords_for_site_task_post(keywords_data_google_ads_keywords_for_site_task_post_request_info=keywords_data_google_ads_keywords_for_site_task_post_request_info)
        print("The response of KeywordsDataApi->google_ads_keywords_for_site_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_site_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_ads_keywords_for_site_task_post_request_info	List[KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_keywords_for_site_tasks_ready

KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResponseInfo google_ads_keywords_for_site_tasks_ready()

‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_keywords_for_site_tasks_ready_response_info import KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_ads_keywords_for_site_tasks_ready()
        print("The response of KeywordsDataApi->google_ads_keywords_for_site_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_keywords_for_site_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_search_volume_live

KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo google_ads_search_volume_live(keywords_data_task_request_info=keywords_data_task_request_info)

‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_search_volume_live_response_info import KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo
from dataforseo_client.models.keywords_data_task_request_info import KeywordsDataTaskRequestInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_task_request_info = [dataforseo_client.KeywordsDataTaskRequestInfo()] # List[KeywordsDataTaskRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_search_volume_live(keywords_data_task_request_info=keywords_data_task_request_info)
        print("The response of KeywordsDataApi->google_ads_search_volume_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_search_volume_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_task_request_info	List[KeywordsDataTaskRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_search_volume_task_get

KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo google_ads_search_volume_task_get(id)

‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_search_volume_task_get_response_info import KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = '251c47ba-60e7-4487-b9cb-31696341ae66' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.google_ads_search_volume_task_get(id)
        print("The response of KeywordsDataApi->google_ads_search_volume_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_search_volume_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_search_volume_task_post

KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo google_ads_search_volume_task_post(keywords_data_task_request_info=keywords_data_task_request_info)

‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_search_volume_task_post_response_info import KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo
from dataforseo_client.models.keywords_data_task_request_info import KeywordsDataTaskRequestInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_task_request_info = [dataforseo_client.KeywordsDataTaskRequestInfo()] # List[KeywordsDataTaskRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_ads_search_volume_task_post(keywords_data_task_request_info=keywords_data_task_request_info)
        print("The response of KeywordsDataApi->google_ads_search_volume_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_search_volume_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_task_request_info	List[KeywordsDataTaskRequestInfo]		[optional]

Return type

KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_search_volume_tasks_ready

KeywordsDataGoogleAdsSearchVolumeTasksReadyResponseInfo google_ads_search_volume_tasks_ready()

‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_search_volume_tasks_ready_response_info import KeywordsDataGoogleAdsSearchVolumeTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_ads_search_volume_tasks_ready()
        print("The response of KeywordsDataApi->google_ads_search_volume_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_search_volume_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsSearchVolumeTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_ads_status

KeywordsDataGoogleAdsStatusResponseInfo google_ads_status()

‌ By calling this endpoint, you will know if Google updated keyword data for the previous month. Generally, Google updates keyword data in the middle of the month. So, if Google updated its data in October, you would be able to see the actual search volume, cost-per-click, competition, and other metrics for September. If Google didn’t update its data in October, the latest information would be available for August. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/status/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_status_response_info import KeywordsDataGoogleAdsStatusResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_ads_status()
        print("The response of KeywordsDataApi->google_ads_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_ads_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsStatusResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_trends_categories

KeywordsDataGoogleTrendsCategoriesResponseInfo google_trends_categories()

By calling this API you will receive the list of categories supported by Google Trends API. ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available categories. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/categories/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_categories_response_info import KeywordsDataGoogleTrendsCategoriesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_trends_categories()
        print("The response of KeywordsDataApi->google_trends_categories:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_trends_categories: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleTrendsCategoriesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_trends_explore_live

KeywordsDataGoogleTrendsExploreLiveResponseInfo google_trends_explore_live(keywords_data_google_trends_explore_live_request_info=keywords_data_google_trends_explore_live_request_info)

This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/live/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_explore_live_request_info import KeywordsDataGoogleTrendsExploreLiveRequestInfo
from dataforseo_client.models.keywords_data_google_trends_explore_live_response_info import KeywordsDataGoogleTrendsExploreLiveResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_trends_explore_live_request_info = [dataforseo_client.KeywordsDataGoogleTrendsExploreLiveRequestInfo()] # List[KeywordsDataGoogleTrendsExploreLiveRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_trends_explore_live(keywords_data_google_trends_explore_live_request_info=keywords_data_google_trends_explore_live_request_info)
        print("The response of KeywordsDataApi->google_trends_explore_live:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_trends_explore_live: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_trends_explore_live_request_info	List[KeywordsDataGoogleTrendsExploreLiveRequestInfo]		[optional]

Return type

KeywordsDataGoogleTrendsExploreLiveResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_trends_explore_task_get

KeywordsDataGoogleTrendsExploreTaskGetResponseInfo google_trends_explore_task_get(id)

‌ for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_get/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_explore_task_get_response_info import KeywordsDataGoogleTrendsExploreTaskGetResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    id = 'cd7d0384-73cf-4e05-8f34-4c42cac0959e' # str | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

    try:
        api_response = api_instance.google_trends_explore_task_get(id)
        print("The response of KeywordsDataApi->google_trends_explore_task_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_trends_explore_task_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time

Return type

KeywordsDataGoogleTrendsExploreTaskGetResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_trends_explore_task_post

KeywordsDataGoogleTrendsExploreTaskPostResponseInfo google_trends_explore_task_post(keywords_data_google_trends_explore_task_post_request_info=keywords_data_google_trends_explore_task_post_request_info)

‌ This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_explore_task_post_request_info import KeywordsDataGoogleTrendsExploreTaskPostRequestInfo
from dataforseo_client.models.keywords_data_google_trends_explore_task_post_response_info import KeywordsDataGoogleTrendsExploreTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_google_trends_explore_task_post_request_info = [dataforseo_client.KeywordsDataGoogleTrendsExploreTaskPostRequestInfo()] # List[KeywordsDataGoogleTrendsExploreTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_trends_explore_task_post(keywords_data_google_trends_explore_task_post_request_info=keywords_data_google_trends_explore_task_post_request_info)
        print("The response of KeywordsDataApi->google_trends_explore_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_trends_explore_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_google_trends_explore_task_post_request_info	List[KeywordsDataGoogleTrendsExploreTaskPostRequestInfo]		[optional]

Return type

KeywordsDataGoogleTrendsExploreTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

google_trends_explore_tasks_ready

KeywordsDataGoogleTrendsExploreTasksReadyResponseInfo google_trends_explore_tasks_ready()

‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_explore_tasks_ready_response_info import KeywordsDataGoogleTrendsExploreTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.google_trends_explore_tasks_ready()
        print("The response of KeywordsDataApi->google_trends_explore_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->google_trends_explore_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleTrendsExploreTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_bing_keyword_performance_locations_and_languages

KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo keywords_data_bing_keyword_performance_locations_and_languages()

‌ Using this endpoint you can get the full list of locations and languages supported in Keyword Performance endpoints of Bing Keywords Data API. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_keyword_performance_locations_and_languages_response_info import KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_bing_keyword_performance_locations_and_languages()
        print("The response of KeywordsDataApi->keywords_data_bing_keyword_performance_locations_and_languages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_bing_keyword_performance_locations_and_languages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_bing_languages

KeywordsDataBingLanguagesResponseInfo keywords_data_bing_languages()

By calling this API you will receive the list of languages supported by Bing Ads API. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/languages/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_languages_response_info import KeywordsDataBingLanguagesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_bing_languages()
        print("The response of KeywordsDataApi->keywords_data_bing_languages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_bing_languages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_bing_locations

KeywordsDataBingLocationsResponseInfo keywords_data_bing_locations()

By calling this API you will receive the list of locations supported in Bing Ads API. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_bing_locations_response_info import KeywordsDataBingLocationsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_bing_locations()
        print("The response of KeywordsDataApi->keywords_data_bing_locations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_bing_locations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataBingLocationsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_errors

KeywordsDataErrorsResponseInfo keywords_data_errors(keywords_data_errors_request_info=keywords_data_errors_request_info)

By calling this endpoint you will receive information about the Keywords Data API tasks that returned an error within the past 24 hours. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/errors/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_errors_request_info import KeywordsDataErrorsRequestInfo
from dataforseo_client.models.keywords_data_errors_response_info import KeywordsDataErrorsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_errors_request_info = [dataforseo_client.KeywordsDataErrorsRequestInfo()] # List[KeywordsDataErrorsRequestInfo] |  (optional)

    try:
        api_response = api_instance.keywords_data_errors(keywords_data_errors_request_info=keywords_data_errors_request_info)
        print("The response of KeywordsDataApi->keywords_data_errors:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_errors: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_errors_request_info	List[KeywordsDataErrorsRequestInfo]		[optional]

Return type

KeywordsDataErrorsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_google_ads_languages

KeywordsDataGoogleAdsLanguagesResponseInfo keywords_data_google_ads_languages()

By calling this API you will receive the list of languages supported by Keywords Data API. ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/languages/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_languages_response_info import KeywordsDataGoogleAdsLanguagesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_google_ads_languages()
        print("The response of KeywordsDataApi->keywords_data_google_ads_languages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_google_ads_languages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_google_ads_locations

KeywordsDataGoogleAdsLocationsResponseInfo keywords_data_google_ads_locations()

‌ We use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”. Postal Codes can be used to set a task, albeit API response will not return data for such tasks. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_ads_locations_response_info import KeywordsDataGoogleAdsLocationsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_google_ads_locations()
        print("The response of KeywordsDataApi->keywords_data_google_ads_locations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_google_ads_locations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleAdsLocationsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_google_trends_languages

KeywordsDataGoogleTrendsLanguagesResponseInfo keywords_data_google_trends_languages()

By calling this API you will receive the list of languages supported by Google Trends API. ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/languages/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_languages_response_info import KeywordsDataGoogleTrendsLanguagesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_google_trends_languages()
        print("The response of KeywordsDataApi->keywords_data_google_trends_languages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_google_trends_languages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleTrendsLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_google_trends_locations

KeywordsDataGoogleTrendsLocationsResponseInfo keywords_data_google_trends_locations()

‌ for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_locations_response_info import KeywordsDataGoogleTrendsLocationsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)

    try:
        api_response = api_instance.keywords_data_google_trends_locations()
        print("The response of KeywordsDataApi->keywords_data_google_trends_locations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_google_trends_locations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

KeywordsDataGoogleTrendsLocationsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_google_trends_locations_country

KeywordsDataGoogleTrendsLocationsCountryResponseInfo keywords_data_google_trends_locations_country(country)

‌ for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_google_trends_locations_country_response_info import KeywordsDataGoogleTrendsLocationsCountryResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    country = 'us' # str | country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

    try:
        api_response = api_instance.keywords_data_google_trends_locations_country(country)
        print("The response of KeywordsDataApi->keywords_data_google_trends_locations_country:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_google_trends_locations_country: %s\n" % e)

Parameters

Name	Type	Description	Notes
country	str	country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

Return type

KeywordsDataGoogleTrendsLocationsCountryResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

keywords_data_id_list

KeywordsDataIdListResponseInfo keywords_data_id_list(keywords_data_id_list_request_info=keywords_data_id_list_request_info)

This endpoint is designed to provide you with the list of IDs and metadata of the completed Keywords Data tasks during the specified period. You will get all task IDs that were made including successful, uncompleted, and tasks that responded as errors. for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/id_list/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.keywords_data_id_list_request_info import KeywordsDataIdListRequestInfo
from dataforseo_client.models.keywords_data_id_list_response_info import KeywordsDataIdListResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.KeywordsDataApi(api_client)
    keywords_data_id_list_request_info = [dataforseo_client.KeywordsDataIdListRequestInfo()] # List[KeywordsDataIdListRequestInfo] |  (optional)

    try:
        api_response = api_instance.keywords_data_id_list(keywords_data_id_list_request_info=keywords_data_id_list_request_info)
        print("The response of KeywordsDataApi->keywords_data_id_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KeywordsDataApi->keywords_data_id_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
keywords_data_id_list_request_info	List[KeywordsDataIdListRequestInfo]		[optional]

Return type

KeywordsDataIdListResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

root / docs

[Back to README.md]