# Ramp Instant SDK and Widget

**Canonical:** https://apis.io/apis/ramp-network/ramp-network-instant-sdk/  
**Provider:** Ramp Network — https://apis.io/providers/ramp-network/  
**Base URL:** https://app.rampnetwork.com  
**Documentation:** https://docs.rampnetwork.com/sdk-reference

Ramp Instant SDK and Widget is one of 2 APIs that [Ramp Network](https://apis.io/providers/ramp-network/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include SDK, Widget, Embedded, and Event. The published artifact set on APIs.io includes API documentation and a getting-started guide.

Client-side integration surface for Ramp Network. The Ramp Instant SDK renders the Ramp widget in overlay, embedded, hosted, mobile or auto variants and emits a typed event stream (WIDGET_CLOSE, WIDGET_CONFIG_DONE, WIDGET_CONFIG_FAILED, PURCHASE_CREATED, OFFRAMP_SALE_CREATED and the close-request events). Configuration is passed as SDK options or as URL search parameters in hosted mode, covering hostApiKey, hostAppName, enabledFlows, userAddress, defaultAsset, selectedCountryCode, webhookStatusUrl, offrampWebhookV3Url, finalUrl and useSendCryptoCallback. Shipped for web, Android, iOS, React Native and Flutter.

## Machine-readable artifacts (4)

- **Documentation** — https://docs.rampnetwork.com/sdk-reference
- **GettingStarted** — https://docs.rampnetwork.com/getting-started
- **Components** — https://raw.githubusercontent.com/api-evangelist/ramp-network/refs/heads/main/components/ramp-network-components.yml
- **SourceCode** — https://github.com/RampNetwork/ramp-instant-sdk

## Other Ramp Network APIs (1)

- [Ramp Network Host API](https://apis.io/apis/ramp-network/ramp-network-host-api/)

## Tags

SDK, Widget, Embedded, Event

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ramp-network/ramp-network-instant-sdk/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ramp-network/.