Nexus Star API v2
Developer Portal

Developer Platform

Nexus Star API Reference

Accept direct-to-wallet cryptocurrency payments, automate business subdomain provisioning, and manage concierge fulfillment with our REST developer platform.

Integration Guide Generate API Keys

Client Drop-in Embed

Drop-in Checkout Modal (Nexus Star Pay)

Verification mark: Powered by Nexus Star

Add a complete checkout modal to your site with one script tag. Customers can pay directly to your self-custody cryptocurrency wallet (BTC, ETH, USDT, USDC) or proceed through concierge checkout. The modal handles address copying, live QR codes, and mempool confirmation monitoring. Every dialog displays the Powered by Nexus Star mark at the bottom.

Integration Code

Include the embed script once on your page, then attach data attributes to any button or call the JavaScript SDK: 

<!-- 1. Include the Nexus Star Pay script -->
<script src="https://api.nexusstar.org/v2/embed.js"></script>

<!-- 2. Add checkout button anywhere in your website -->
<button data-nexus-checkout
        data-name="Custom Website Starter"
        data-amount="299.00"
        data-currency="USD"
        data-product-id="custom-website-starter"
        data-wallet="0xYourEthereumOrUsdtWalletAddress">
  Pay with Nexus Star
</button>
<script src="https://api.nexusstar.org/v2/embed.js"></script>

<script>
  function openCheckout() {
    NexusStarPay.open({
      name: "Custom Website Starter",
      amount: 299.00,
      currency: "USD",
      productId: "custom-website-starter",
      recipientWallet: "0xYourWalletAddressHere",
      customerEmail: "[email protected]",
      onSuccess: function (invoice) {
        console.log("Transaction confirmed:", invoice.txHash);
      },
      onClose: function () {
        console.log("Checkout modal dismissed");
      }
    });
  }
</script>
import React, { useEffect } from 'react';

export default function CheckoutButton() {
  useEffect(() => {
    const script = document.createElement('script');
    script.src = 'https://api.nexusstar.org/v2/embed.js';
    script.async = true;
    document.body.appendChild(script);
    return () => document.body.removeChild(script);
  }, []);

  const handlePay = () => {
    window.NexusStarPay?.open({
      name: "Pro Media Tools Pass",
      amount: 5.00,
      currency: "USD",
      productId: "media-tools-pro"
    });
  };

  return (
    <button onClick={handlePay} className="btn btn-primary">
      Pay with Nexus Star
    </button>
  );
}

Getting Started

Quickstart & Authentication

Connect to our developer endpoints in three steps. All requests authenticate over HTTPS using API keys.

1. Get API Key

Obtain your production token from the Developer Portal. Keys use the prefix nx_live_....

2. Base URL

All client developer endpoints are rooted at https://api.nexusstar.org/v2. Internal company systems run privately on /v1.

3. Direct Settlement

Crypto invoices transfer funds directly peer-to-peer into your self-custody wallet, avoiding third-party holdings and tax complications.

HTTP Request Header 
Authorization: Bearer nx_live_9a4f2c018e6b4d32a10e7b45
# Alternatively:
X-API-Key: nx_live_9a4f2c018e6b4d32a10e7b45

API Reference

Endpoints Reference (/v2)

Production endpoints for invoicing, blockchain mempool monitoring, subdomain provisioning, and concierge fulfillment.

POST /v2/crypto/invoices

Generate a direct-to-wallet cryptocurrency invoice. The customer sends payment directly to your self-custody address (BTC, ETH, USDT, or USDC).

Parameter Type Description
amountrequired number Amount in USD (e.g., 299.00). Converted into live satoshis/wei.
assetrequired string One of: BTC, ETH, USDT_ERC20, USDT_TRC20, USDC.
recipientWalletrequired string Your destination cryptocurrency wallet address.
orderId string Your internal reference ID (e.g., order_84920).
customerEmail string Email address for receipt delivery. 
curl -X POST "https://api.nexusstar.org/v2/crypto/invoices" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 299.00,
    "asset": "USDT_ERC20",
    "recipientWallet": "0x71C...YourWalletAddress",
    "orderId": "order_84920",
    "customerEmail": "[email protected]"
  }'
const res = await fetch("https://api.nexusstar.org/v2/crypto/invoices", {
  method: "POST",
  headers: {
    "Authorization": "Bearer nx_live_your_key_here",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    amount: 299.00,
    asset: "USDT_ERC20",
    recipientWallet: "0x71C...YourWalletAddress",
    orderId: "order_84920",
    customerEmail: "[email protected]"
  })
});
const data = await res.json();
console.log("Invoice ID:", data.data.invoiceId);
import requests

res = requests.post(
    "https://api.nexusstar.org/v2/crypto/invoices",
    headers={"Authorization": "Bearer nx_live_your_key_here"},
    json={
        "amount": 299.00,
        "asset": "USDT_ERC20",
        "recipientWallet": "0x71C...YourWalletAddress",
        "orderId": "order_84920",
        "customerEmail": "[email protected]"
    }
)
print("Invoice ID:", res.json()["data"]["invoiceId"])
POST /v2/crypto/detect

Register a webhook listener for incoming cryptocurrency transfers. Receive zero-confirmation notifications (tx.mempool_detected) when a transaction enters the mempool, and block confirmations (tx.confirmed) once mined.

cURL • Register Webhook 
curl -X POST "https://api.nexusstar.org/v2/crypto/detect" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "walletAddress": "0x71C...YourWalletAddress",
    "asset": "USDT_ERC20",
    "webhookUrl": "https://yourdomain.com/api/webhooks/crypto",
    "expectedAmount": 299.00
  }'
POST /v2/crypto/check

Check real-time on-chain payment and mempool confirmation status for a destination wallet address. Features sliding-window edge caching (8s) to protect Cloudflare request capacity.

cURL • Check Payment Status 
curl -X POST "https://api.nexusstar.org/v2/crypto/check" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "0x71C...YourWalletAddress",
    "asset": "USDT_ERC20",
    "amount": 299.00
  }'
POST /v2/domains/provision

Provision branded subdomains under nexusbuilds.me, nexusstar.studio, nexusstar.tech, or v3xyservices.com with automated SSL certificate deployment.

Node.js • Provision Subdomain 
const res = await fetch("https://api.nexusstar.org/v2/domains/provision", {
  method: "POST",
  headers: {
    "Authorization": "Bearer nx_live_your_key_here",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    subdomain: "store",
    zone: "nexusbuilds.me",
    targetIp: "192.0.2.1",
    enableSsl: true
  })
});
const result = await res.json();
console.log("Provisioned URL:", result.data.fqdn); // https://store.nexusbuilds.me
POST /v2/concierge/orders

Dispatch digital entertainment and technical setup concierge orders for your customers.

cURL • Dispatch Order 
curl -X POST "https://api.nexusstar.org/v2/concierge/orders" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "youtube-premium-concierge",
    "customerEmail": "[email protected]",
    "planDuration": "monthly"
  }'
POST /v2/media/optimize

Convert and compress product images to WebP/AVIF format with global CDN edge caching.

cURL • Optimize Media 
curl -X POST "https://api.nexusstar.org/v2/media/optimize" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceUrl": "https://nexusstar.org/nexus.svg",
    "format": "webp",
    "quality": 85,
    "width": 1200
  }'
GET /v2/crypto/rates

Retrieve real-time market spot rates for BTC, ETH, SOL, USDT, and USDC in USD from Coinbase with 30-second edge caching. Available on all tiers with zero third-party custody.

cURL • Fetch Spot Rates 
curl -X GET "https://api.nexusstar.org/v2/crypto/rates" \
  -H "Authorization: Bearer nx_live_your_key_here"
POST /v2/crypto/validate

Validate recipient cryptocurrency addresses before generating invoices. Supports Bitcoin (Native SegWit Bech32 & Legacy Base58), Ethereum/EVM (EIP-55 hex), Tron (TRC20 Base58Check), and Solana (Base58).

cURL • Validate Address 
curl -X POST "https://api.nexusstar.org/v2/crypto/validate" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "0x71C63742415UEe738ec59c0521a27517623113",
    "asset": "USDT_ERC20"
  }'
GET /v2/transactions

Query your live invoice history, detected mempool signals, and confirmed blockchain transactions. Real-time updates sync directly to your Developer Portal ledger.

cURL • List Transactions 
curl -X GET "https://api.nexusstar.org/v2/transactions" \
  -H "Authorization: Bearer nx_live_your_key_here"
GET /v2/account

Inspect your active subscription tier (Starlight Starter, Pulsar Pro, or Supernova Enterprise), current rate limit allocations, daily quota capacity, and Persona KYC verification status.

cURL • Check Account & Quota 
curl -X GET "https://api.nexusstar.org/v2/account" \
  -H "Authorization: Bearer nx_live_your_key_here"
POST /v2/webhooks/simulate

Simulate signed webhook delivery to your development or staging server. Generates real SHA-256 HMAC signatures (X-Nexus-Signature) for tx.mempool_detected, tx.confirmed, or custom payloads.

cURL • Simulate Webhook Event 
curl -X POST "https://api.nexusstar.org/v2/webhooks/simulate" \
  -H "Authorization: Bearer nx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "targetUrl": "https://yourdomain.com/api/webhooks/crypto",
    "eventType": "tx.confirmed"
  }'
GET /v2/domains/list

List all active subdomains provisioned under your developer account across nexusbuilds.me, nexusstar.studio, nexusstar.tech, and v3xyservices.com.

cURL • List Subdomains 
curl -X GET "https://api.nexusstar.org/v2/domains/list" \
  -H "Authorization: Bearer nx_live_your_key_here"

Sandbox Testing

Interactive API Console

Test live API requests directly in your browser against the production gateway.

Live JSON Response:

// Select an endpoint and click "Send Request" to test...

Flexible Subscriptions

Developer API Plans

Choose the plan that fits your business. Scale seamlessly from prototyping to high-volume commercial production with direct-to-wallet settlement.

Account Default

Tier 1 • Starlight Starter

Instant access upon creating an account.

$0 / forever
  • 1,000 requests per day (60 req/min)
  • 1 custom subdomain on nexusbuilds.me
  • Real-time market rates engine (/v2/crypto/rates)
  • Multi-chain address validator (/v2/crypto/validate)
  • Standard REST API & documentation access
  • Community support
Create Free Account
Unlocked with KYC
Identity Verified

Tier 2 • Pulsar Pro

Granted automatically when you verify identity with Persona (18+).

Free with ID Verification
  • 25,000 requests per day (1,500 req/min)
  • Direct-to-wallet cryptocurrency checkout
  • Embeddable drop-in checkout modal & SDK
  • 0-conf instant mempool WebSocket notifications
  • High-throughput HMAC webhooks
  • Up to 10 automated subdomains across all zones
  • Zero platform fee on direct crypto invoices
Verify Identity to Unlock Free
Full Platform Pass
High Volume

Tier 3 • Supernova Enterprise

Maximum platform capacity for high-volume commercial scaling.

$19 / month
  • 100,000 requests per day (5,000 req/min)
  • Unlimited subdomains across all 4 root zones
  • Custom domain white-labeling for checkout
  • Multi-asset batch invoicing & auto-routing
  • Priority Cloudflare edge routing & auto SSL
  • 99.9% uptime SLA guarantee
  • Dedicated engineering concierge & architecture review
Subscribe to Enterprise ($19/mo)

Infrastructure

Rate Limits & Compliance

Platform quotas ensure system availability while supporting high-throughput production workloads.

Tier 1 • Starlight Starter

Default tier for all standard registered accounts.

  • 1,000 requests per day (60 req/min)
  • 1 subdomain slug on nexusbuilds.me
  • Real-time market exchange rates (/v2/crypto/rates)
  • Multi-chain wallet address validator (/v2/crypto/validate)
  • Standard documentation & community support

Tier 2 • Pulsar Pro

Unlocked free for all Persona 18+ verified accounts.

  • 25,000 requests per day (1,500 req/min)
  • Direct-to-wallet cryptocurrency checkout
  • Up to 10 automated subdomains across all zones
  • Embeddable checkout modal (Nexus Star Pay)
  • Instant mempool 0-conf WebSocket webhooks
  • HMAC webhook signature simulator suite

Tier 3 • Supernova Enterprise

$19/mo subscription for enterprise platform capacity.

  • 100,000 requests per day (5,000 req/min)
  • Unlimited automated subdomains across all 4 zones
  • Dedicated Cloudflare edge routing & auto SSL
  • Custom domain white-labeling for payment modal
  • 99.9% uptime SLA guarantee
  • Dedicated engineering concierge & priority support