ddx-interactions-api
Interactions API documentation
Python client for the DDx Interactions API, generated from its OpenAPI specification.
- API version: v1
- Package version: 0.4.0
- Generator version: 7.10.0
For more information, please visit https://demexchange.com/.
For support for this package or the DDx Interactions API please contact us at api@demexchange.com
Requirements
Python 3.8+
Installation
pip install ddx-interactions-api
Then import the package:
import ddx_interactions_api
Changelog
API changes are recorded in the changelog, regenerated from a diff of the OpenAPI specification on each sync. Entries marked breaking require a change on the consumer side.
Reporting issues
This package is generated; edits to it are overwritten on the next spec sync. Report problems against the API specification rather than the generated code.
Getting Started
Validating an integration end to end? The UAT guide walks through install, authentication, submitting an interaction, and confirming it reached the Exchange.
import ddx_interactions_api
from ddx_interactions_api.rest import ApiException
from pprint import pprint
# Authentication is HTTP basic, with your API key in the password field and an
# empty username. The key has the form "<keyId>.<secret>".
#
# The host defaults to https://api.movementinfrastructure.org. Pass host= to target another server.
# See configuration.py for all supported parameters.
import os
configuration = ddx_interactions_api.Configuration(
username = "",
password = os.environ["DDX_API_KEY"],
)
# Enter a context with an instance of the API client
with ddx_interactions_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ddx_interactions_api.AuthenticationDetailsApi(api_client)
version = '1' # str | (default to '1')
try:
# Get authentication context
api_response = api_instance.vversion_auth_me_get(version)
print("The response of AuthenticationDetailsApi->vversion_auth_me_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthenticationDetailsApi->vversion_auth_me_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.movementinfrastructure.org
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthenticationDetailsApi | vversion_auth_me_get | GET /v{version}/auth/me | Get authentication context |
| InteractionsApi | vversion_interactions_exchange_status_get | GET /v{version}/interactions/exchange-status | Get Exchange pipeline statuses by correlation or interaction ID |
| InteractionsApi | vversion_interactions_exchange_status_range_get | GET /v{version}/interactions/exchange-status/range | Get Exchange pipeline statuses by date range |
| InteractionsApi | vversion_interactions_interaction_id_transactions_get | GET /v{version}/interactions/{interactionId}/transactions | Get external API transactions by interactionId |
| InteractionsApi | vversion_interactions_post | POST /v{version}/interactions | Post interactions data |
| InteractionsApi | vversion_interactions_transactions_get | GET /v{version}/interactions/transactions | Get external API transaction logs by date range |
Documentation For Models
- AcceptedInteractionDto
- AcceptedInteractionsDto
- ActivistCode
- ActivistCodeOutcomeDetails
- Address
- AddressChannelDetails
- CanvasserDetails
- CommitteeDetails
- CommunicationConsent
- CommunicationConsentOutcomeDetails
- CommunicationConsentStatus
- ContactInfo
- ContactMethod
- DynamicChannelDetails
- DynamicOutcomeDetails
- EventDetails
- EventRole
- EventSignup
- EventSignupOutcomeDetails
- EventSignupStatus
- EventSignupStatusValue
- ExchangeInteractionStatus
- ExchangeInteractionStatusDto
- ExchangeInteractionStatusDtoCursorPaginatedResponseDto
- ExternalApiKeyStatus
- ExternalApiKeyType
- ExternalTransactionStatus
- InitiativeDto
- InteractionDto
- InteractionDtoChannel
- InteractionDtoOutcomesDetailedInner
- InteractionErrorDto
- InteractionVanFieldsDto
- InteractionsBatchResultDto
- InteractionsDto
- InteractionsExternalApiTransactionDto
- InteractionsExternalApiTransactionDtoGetResponseDto
- InteractionsExternalApiTransactionLogDto
- MercuryDestinationVanApiKeyDto
- MinervaMetadataDto
- Outcome
- OutcomeDetailOperation
- PersonIdentifier
- ProblemDetails
- RejectedInteractionDto
- RejectedInteractionsDto
- SimpleDestinationDto
- SimpleMovementAppDto
- SimpleWorkspaceDto
- SurveyResponse
- SurveyResponseOutcomeDetails
- VanApiKeyDto
- VanDatabaseMode
- WhoAmIApiKeyDto
- WorkspaceTypeDto
Documentation For Authorization
Authentication schemes defined for the API:
Basic
- Type: HTTP basic authentication
Author
Metadata
Release files for ddx-interactions-api 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ddx_interactions_api-0.4.0.tar.gz | 47.6 kB | With provenance | Details for ddx_interactions_api-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ddx_interactions_api-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for ddx_interactions_api-0.4.0-py3-none-any.whl |
Total release size: 154.3 kB
Release files / ddx_interactions_api-0.4.0.tar.gz
| Download URL | ddx_interactions_api-0.4.0.tar.gz |
|---|---|
| Size | 47.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9ae51cb43f89eceb03d5d14ba40d8b1906ba5e3cecc363d1ebf840599061da45
|
|
BLAKE2b-256 checksum How to use checksums |
ad4d8d889cee21c43012dfe68175c51972cc58dc9d7c68c2e16ea634c31892a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / ddx_interactions_api-0.4.0-py3-none-any.whl
| Download URL | ddx_interactions_api-0.4.0-py3-none-any.whl |
|---|---|
| Size | 106.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
716743001e24947ef59c01be01462dc5edad297bbd6da1c6a68205eca0292a57
|
|
BLAKE2b-256 checksum How to use checksums |
9413e6bf59e3507f85e0ead08545a6f58714f82006c9517c775d34d6eeefea49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logSecurity for ddx-interactions-api 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for ddx_interactions_api-0.4.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.