Introduction
The Matterport 3D Showcase SDK is a JavaScript library that third-party developers can use to integrate Matterport into their web applications.
The SDK allows developers to deeply customize 3D Showcase and build completely new applications on top of the Matterport platform.
Matterport offers several SDK distributions to suit different integration needs.
SDK Distributions
Showcase Embed SDK
With this SDK, developers can control movement, view modes, and creation of custom 2D content within an embedded version of the Matterport Showcase that always stays up-to-date with our latest improvements.
The Embed SDK is available via:
- Script tag - Load directly from Matterport's CDN
- NPM package - @matterport/sdk with TypeScript definitions
Showcase Bundle SDK
The Bundle SDK is a self-hosted version of the Matterport Showcase.
In addition to what's available in the Embed SDK, the Bundle SDK provides the Scene Framework, which allows access to the 3D engine and scene graph.
Web Component (Beta)
An isolated distribution of the SDK Bundle that encapsulates the Showcase Player within a single DOM element. The Web Component provides a containerized approach to integration.
Choosing the Right SDK
| Use Case | Recommended SDK |
|---|---|
| Embed Matterport with basic controls | Embed SDK |
| Custom UI overlays and interactions | Embed SDK |
| Add 3D objects to the scene | Bundle SDK |
| Custom lighting and materials | Bundle SDK |
| Non-Iframe Bundle distribution | Web Component |
GraphQL APIs
In addition to the SDKs, Matterport provides GraphQL APIs for querying model metadata, spatial data, and property intelligence.
Getting Help
- Browse the SDK Reference for detailed API documentation
- Check the SDK Changelog for the latest updates
- Visit Matterport Support for additional resources