Making GraphQL API calls

To make a GraphQL API call, you need the following:

The Trade Desk Platform API credentials provided by your Account Manager.
Your API token. For details, see Authentication.
Your tool or method of choice for making API calls (for example, Postman or Python).
A header (TTD-Auth) with your API token.
The URL for the environment you want to use.

Environment URLs

IMPORTANT: Complexity and rate limits apply to all platform GraphQL API calls. For details, see GraphQL API rate limits and GraphQL API errors and complexity limits.

The following table lists the URLs for the environments that you can use. If you are using Walmart DSP, see Walmart DSP URLs.

Although you can use any tool of your choice to execute a GraphQL call, the following sections explain how to do so in Postman and Python.

Postman

To make a GraphQL call in Postman, complete the following steps:

1. To create a new request, in the left panel and at the top, click New and choose GraphQL as your request type.
2. Enter the URL for the environment you want to use (sandbox or production).
3. Click the Headers tab, and in the Key field, enter TTD-Auth, and in the Value field, enter your API token.
4. To retrieve your schema, go to the Schema tab and click Use GraphQL Introspective.
5. On the Query tab, do either of the following:
   • To automatically generate and add fields to your query, select the available fields in the left pane and enter the appropriate values as needed.
   • To manually create your query, use the right pane.
6. To send your request to the GraphQL Platform API, click the blue Query button at the top-right.

The response appears in the bottom pane with the details you requested. For details on the query anatomy and usage guidelines, see GraphQL API queries. For a list of client libraries, see Code Using GraphQL.

Python

The following example demonstrates a GraphQL call in Python.

IMPORTANT: To make GraphQL Platform API calls with Python, be sure to have the requests library installed on your system; for example, the GraphQLPythonlibrary on GitHub. See also Code Using GraphQL.

Placeholder values that you must replace are shown in ALL CAPS.

import requests
 
# Define the GraphQL Platform API endpoint URLs.
sandbox_url = 'https://ext-api.sb.thetradedesk.com/graphql'
production_url = 'https://api.thetradedesk.com/graphql'
 
# Replace the placeholder value with your actual API token.
token = 'API_TOKEN_PLACEHOLDER'
 
# Define the GraphQL query.
query = """
query GetAdvertiser($advertiserId: ID!) {
    advertiser(id: $advertiserId) {
        id
        name
    }
}
"""
 
# Define the variables in the query.
variables = {
    "advertiserId": "ADVERTISER_ID_PLACEHOLDER"
}
 
# Create a dictionary for the GraphQL request.
data = {
    'query': query,
    'variables': variables
}
 
# Create headers with the authorization token.
headers = {
    # You can only use 1 auth header. You must choose 'TTD-Auth' (preferred) or 'Authorization'.
 
    # DeskAPI and UnifiedAPI Tokens ONLY
    'TTD-Auth': token
 
    # DeskUI JWT Token ONLY
    # 'Authorization': f'Bearer {token}'
}
 
# Send the GraphQL request.
# The `url` param is used only for demonstration purposes. Be sure to replace it with the GraphQL platform API URL you want to target.
response = requests.post(url=sandbox_url, json=data, headers=headers)
 
if response.status_code == 200:
    # Parse the response JSON
    result = response.json()
    print(result)
else:
    print(f"Request failed with status code: {response.status_code}")
    print(response.text)

Platform GraphQL API resources

Here's a list of resources you can use to learn about the GraphQL API:

Walmart DSP URLs

The following table lists the URLs for Walmart DSP. Be sure to update the Postman and Python examples to use the corresponding sandbox_url and production_url values.