Get Started
Back to Docs

SDKs & Libraries

Official and community-maintained SDKs to integrate Yeld into your application.

Available SDKs

Choose the SDK that fits your stack. All SDKs support core Yeld functionality.

1

JavaScript/TypeScript SDK

@yeld/sdk

Install: \`$npm install @yeld/sdk\`

  • Type-safe API calls
  • Automatic retry logic
  • Webhook signature verification
  • Promise-based API
import { YeldClient } from "@yeld/sdk";

const client = new YeldClient({
  apiKey: process.env.YELD_API_KEY,
});

// Create a checkout link
const link = await client.checkoutLinks.create({
  bizId: "biz_abc123",
  planName: "Premium Plan",
  price: "50.00",
  billing: "recurring",
});

console.log(link.url); // https://pay.yeld.app/plan_abc123
2

Python SDK

yeld-sdk

Install: \`$pip install yeld-sdk\`

  • Async/await support
  • Type hints
  • Official documentation
  • Community supported
from yeld import YeldClient

client = YeldClient(api_key="your_api_key")

# Create a checkout link
link = client.checkout_links.create(
    biz_id="biz_abc123",
    plan_name="Premium Plan",
    price="50.00",
    billing="recurring"
)

print(link.url)
3

Node.js (Direct API)

axios (or native fetch)

Install: \`$npm install axios\`

  • Lightweight
  • No extra dependencies
  • Works with any framework
  • Full control
import axios from "axios";

const apiKey = process.env.YELD_API_KEY;

// Create a checkout link
const response = await axios.post(
  "https://api.yeld.app/v1/checkout-links/biz_abc123",
  {
    planName: "Premium Plan",
    price: "50.00",
    billing: "recurring",
  },
  {
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
  }
);

console.log(response.data);

Core Library (yeld-app)

Your project includes core utilities for working with Yeld:

@/lib/checkout-links

Server actions for creating and managing checkout links.

createCheckoutLink(bizId, input)
getCheckoutLinks(bizId)
getCheckoutLinkByPlanId(planId)
deleteCheckoutLink(bizId, planId)

@/lib/businesses

Business entity management utilities.

generateBizId()
getBusinessesForUser(ownerId)
getBusiness(bizId)
getBusinessById(id)

@/lib/evm

EVM wallet derivation utilities.

masterMnemonic()
derivationPath(index)
deriveBusinessAddress(index)

@/lib/prices

Crypto price fetching and USD conversion.

getRealtimePrices()
usdForSymbol({ symbol, balance, prices })

Getting Started

  1. Install the SDK for your language
  2. Get your API key from the dashboard
  3. Configure environment variables
  4. Follow the quick start guide
Authentication →