Skip to main content

Getting Started with MX Platform API

Introduction

The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.

What's Changed?

Several endpoints, headers, and fields changed in v20250224. For more on breaking changes, refer to our versioning and migration guides.

Version Header

Versions are set in the Accept-Version header of API requests. Version numbers correspond with the date associated with that version. The example below uses the version v20250224.

-H 'Accept: application/json'
-H 'Accept-Version: v20250224'

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-mx-apis-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/apimatic-mx-apis-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
basic_auth_credentials BasicAuthCredentials The credential object for Basic Authentication
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from mxplatformapi.configuration import Environment
from mxplatformapi.http.auth.basic_auth import BasicAuthCredentials
from mxplatformapi.http.auth.bearer_auth import BearerAuthCredentials
from mxplatformapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from mxplatformapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from mxplatformapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from mxplatformapi.mxplatformapi_client import MxplatformapiClient

client = MxplatformapiClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from mxplatformapi.mxplatformapi_client import MxplatformapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = MxplatformapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION Default
ENVIRONMENT2 -

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-mx-apis-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apimatic-mx-apis-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_mx_apis_sdk-0.0.1.tar.gz 193.0 kB Without provenance Details for apimatic_mx_apis_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-mx-apis-sdk 0.0.1
File Interpreter ABI Platform Actions
apimatic_mx_apis_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for apimatic_mx_apis_sdk-0.0.1-py3-none-any.whl

Total release size: 685.4 kB

Release files / apimatic_mx_apis_sdk-0.0.1.tar.gz

Download URL apimatic_mx_apis_sdk-0.0.1.tar.gz
Size 193.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8bed1d282dd522c3a4f671d3054b77224895a153b11acdbffc1676b7013c0627
BLAKE2b-256 checksum
How to use checksums
cb1540510dc5ab6c64c114481f0936bd86544282f69978ffcb9b97ba493cd8eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_mx_apis_sdk-0.0.1-py3-none-any.whl

Download URL apimatic_mx_apis_sdk-0.0.1-py3-none-any.whl
Size 492.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
17ab787e9e46951476a183c9a86cea47f1449c74e879202cce0a66d115b6047d
BLAKE2b-256 checksum
How to use checksums
d0a906456208d2bd3b170f61d9481b8badac5157b21b0f01c350e1316dbffe8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-mx-apis-sdk 0.0.1

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A 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.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page