npm install @nowramp/sdk
# or
yarn add @nowramp/sdk
# or
pnpm add @nowramp/sdk

import { RampApi } from '@nowramp/sdk';

const api = new RampApi({ projectId: 'your_project_id' });

// 1. Get supported currencies and payment methods
const supported = await api.getSupported();

// 2. Get ranked quotes from all gateways
const quotes = await api.getQuotes({
  fiatCurrency: 'USD',
  fiatAmount: '100',
  cryptoCurrency: 'ETH',
  network: 'ethereum'
});

// 3. Create checkout with the best quote's gateway
const intent = await api.createCheckoutIntent({
  gateway: quotes.bestQuote.gatewayId,
  fiatCurrency: 'USD',
  fiatAmount: '100',
  cryptoCurrency: 'ETH',
  network: 'ethereum',
  walletAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f1bD21'
});

// 4. Redirect user to the gateway's checkout
window.location.href = intent.checkout.url;

new RampApi(config: RampApiConfig)

interface RampApiConfig {
  projectId: string;       // Your project ID (required)
  apiKey?: string;         // Optional pk_ key for higher rate limits
  apiUrl?: string;         // Default: https://api.nowramp.com
}

const config = await api.getSupported({ orderType: 'buy', country: 'US' });

console.log(config.gateways);       // Available payment gateways
console.log(config.fiats);          // Supported fiat currencies with min/max
console.log(config.cryptos);        // Supported cryptocurrencies with networks
console.log(config.paymentMethods); // Available payment methods
console.log(config.defaultGateway); // Project's default gateway

const result = await api.getQuotes({
  fiatCurrency: 'USD',
  fiatAmount: '100',
  cryptoCurrency: 'ETH',
  network: 'ethereum',
  paymentMethodId: 'debit-credit-card', // optional
  country: 'US'                         // optional
});

console.log(result.bestQuote);             // Best exchange rate
console.log(result.fastestQuote);          // Shortest processing time
console.log(result.cheapestFees);          // Lowest total fees
console.log(result.quotes);               // All quotes, ranked
console.log(result.unavailableGateways);  // Gateways that couldn't quote

const intent = await api.createCheckoutIntent({
  gateway: 'gateway_id',
  fiatCurrency: 'USD',
  fiatAmount: '100',
  cryptoCurrency: 'ETH',
  network: 'ethereum',
  walletAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f1bD21',
  externalCustomerId: 'user_123',
  email: '[email protected]',
  redirectUrl: 'https://myapp.com/complete'
});

console.log(intent.orderId);            // Order ID for tracking
console.log(intent.checkout.method);     // 'iframe' | 'redirect' | 'widget'
console.log(intent.checkout.url);        // Checkout URL

const tx = await api.getTransaction('order-uuid-here');

console.log(tx.status);            // 'pending' | 'processing' | 'completed' | 'failed' | ...
console.log(tx.cryptoAmount);      // Crypto amount received
console.log(tx.transactionHash);   // Blockchain TX hash (if available)

const result = await api.validateAddress({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f1bD21',
  network: 'ethereum'
});

console.log(result.isValid);       // true
console.log(result.chainType);     // 'evm'

const networks = await api.getSupportedNetworks();
// [{ id: 'ethereum', name: 'Ethereum', chainType: 'evm' }, ...]

import {
  getSupported,
  getQuotes,
  createCheckoutIntent,
  getTransaction,
  validateAddress,
  getSupportedNetworks
} from '@nowramp/sdk';

const config = await getSupported(
  { projectId: 'your_project_id' }
);

const quotes = await getQuotes(
  { projectId: 'your_project_id' },
  { fiatCurrency: 'USD', fiatAmount: '100', cryptoCurrency: 'ETH', network: 'ethereum' }
);

const intent = await createCheckoutIntent(
  { projectId: 'your_project_id' },
  {
    gateway: quotes.bestQuote.gatewayId,
    fiatCurrency: 'USD',
    fiatAmount: '100',
    cryptoCurrency: 'ETH',
    network: 'ethereum',
    walletAddress: '0x...'
  }
);

const tx = await getTransaction(
  { apiUrl: 'https://api.nowramp.com' },
  intent.orderId
);

import type {
  RampApi,
  RampApiConfig,
  FlowType,
  QuoteData,
  CheckoutIntent,
  Transaction
} from '@nowramp/sdk';

<script src="https://unpkg.com/@nowramp/sdk/dist/index.umd.js"></script>
<script>
  const api = new NowRamp.RampApi({
    projectId: 'your_project_id'
  });

  api.getQuotes({
    fiatCurrency: 'USD',
    fiatAmount: '100',
    cryptoCurrency: 'ETH',
    network: 'ethereum'
  }).then(quotes => {
    console.log('Best rate:', quotes.bestQuote);
  });
</script>

// Deprecated — use getQuotes() instead
const rate = await api.getRate({
  from: 'USD',
  to: 'ETH',
  amount: 100,
  flowType: 'buy' // optional, default: 'buy'
});

console.log(rate.rate);                // Exchange rate
console.log(rate.destinationAmount);   // Crypto amount after fees
console.log(rate.fees.totalFee);       // Total fee
console.log(rate.provider);            // Single provider name

interface RateResult {
  rate: number;
  sourceAmount: number;
  sourceCurrency: string;
  destinationAmount: number;
  destinationCurrency: string;
  fees: {
    processingFee: number;
    processingFeePercent: number;
    networkFee: number;
    totalFee: number;
  };
  provider: string;
  expiresAt?: string;
}

// Before (single provider)
const rate = await api.getRate({ from: 'USD', to: 'ETH', amount: 100 });

// After (all providers, ranked)
const { bestQuote, quotes } = await api.getQuotes({
  fiatCurrency: 'USD',
  cryptoCurrency: 'ETH',
  network: 'ethereum',
  fiatAmount: '100'
});

// Deprecated — use getSupported() instead
const currencies = await api.getCurrencies();

console.log(currencies.fiat);        // Fiat currencies
console.log(currencies.crypto);      // Crypto currencies
console.log(currencies.provider);    // Single provider name

// Before (single provider)
const currencies = await api.getCurrencies();

// After (all providers, with payment methods and gateways)
const supported = await api.getSupported({ orderType: 'buy' });
console.log(supported.fiats);          // All fiat currencies across gateways
console.log(supported.cryptos);        // All crypto currencies with networks
console.log(supported.paymentMethods); // Available payment methods
console.log(supported.gateways);       // Available gateways

import { getRate, getCurrencies } from '@nowramp/sdk';

// Deprecated — use getQuotes() and getSupported() instead
const rate = await getRate({ projectId: 'your_project_id' }, { from: 'USD', to: 'ETH', amount: 100 });
const currencies = await getCurrencies({ projectId: 'your_project_id' });