Interactions API SDKs

Use a generated client library instead of hand-rolling HTTP calls against the Interactions API.

The SDKs for Interactions API are generated from the API's OpenAPI
specification, so the request and response models always match the API. They
give you typed models, authentication handling, and error types, rather than
building requests by hand.

Python

ddx-interactions-api on PyPI.
Requires Python 3.8 or later.

pip install ddx-interactions-api

The install name is hyphenated and the import name is underscored:

import ddx_interactions_api

Authentication is HTTP Basic, with your API key in the password field and
the username left empty. See
Interactions API Authentication for how
to request a key.

import os
import ddx_interactions_api as sdk

configuration = sdk.Configuration(
    username="",
    password=os.environ["DDX_API_KEY"],
)

with sdk.ApiClient(configuration) as client:
    me = sdk.AuthenticationDetailsApi(client).vversion_auth_me_get("1")
    print(me.workspace.display_name)

The host defaults to the production API.

Every method takes the API version as its first argument. "1" corresponds to
the v1 in the request path.

The package page documents the
full client surface, including submitting interactions and reading Exchange
status. Model shapes are in the
API Reference.

Other languages

Ruby, Node, and C# libraries are in progress. This page will list them once they are
published.

In the meantime, the API is a plain JSON HTTP interface and can be called
directly from any language. See the
Quick Start for Data Sources and the
API Reference.


What’s Next

Did this page help you?