MX Platform Node.js SDK

This repository contains the Node.js SDK for the MX Platform API. The SDK supports multiple API versions, published as independent major versions of the same npm package.

Which API Version Do You Need?

API Version	npm Package	Major Versions	Documentation
v20111101	mx-platform-node@^2	2.x.x	v20111101 SDK README, v20111101 API Docs
v20250224	mx-platform-node@^3	3.x.x	v20250224 SDK README, v20250224 API Docs

Installation

# For v20111101 API
npm install mx-platform-node@^2

# For v20250224 API
npm install mx-platform-node@^3

API Migration

If you're upgrading from v20111101 to v20250224, see the MX Platform API Migration Guide.

Repository Structure

This repository uses OpenAPI Generator to automatically generate TypeScript SDKs from OpenAPI specifications.

v20111101/              # Generated SDK for v20111101 API
v20250224/              # Generated SDK for v20250224 API
openapi/                # SDK generation configuration and templates
.github/workflows/      # Automation for generation, publishing, and releasing
docs/                   # Repository documentation and contribution guidelines

For Contributors

For detailed information about:

• How the SDK generation process works
• How to contribute to this repository
• Publishing and release workflows
• Architecture and design decisions

Please see the docs/ directory.

Support

• SDK Issues: Open an issue
• API Documentation: MX Platform API Docs
• API Changelog: MX Platform Changelog