SDKs and tools

pip install scripx

npm install @scripx/sdk

from scripx import ScripxClient

sx = ScripxClient("scripx_live_…")                 # or a scripx_test_… key for sandbox
# options: base_url, timeout (seconds), max_retries

import { Scripx } from "@scripx/sdk";

const sx = new Scripx({ apiKey: "scripx_live_…" }); // or a scripx_test_… key for sandbox
// options: baseUrl, timeout (ms), maxRetries

# SELL side: price a whole face, then place the order with a price floor
quote = sx.quotes.sell(scheme="RODTEP", face_paise=100_000_000)
print(quote["price_bps"], quote["all_in_paise"])

result = sx.orders.create(
    side="sell", scheme="RODTEP", amount_paise=100_000_000, min_pct_bps=9600,
)
order = result["order"]
sx.orders.get(order["id"])

// SELL side: price a whole face, then place the order with a price floor
const quote = await sx.quotes.sell({ scheme: "RODTEP", face_paise: 100_000_000 });
console.log(quote.price_bps, quote.all_in_paise);

const { order } = await sx.orders.create({
  side: "sell", scheme: "RODTEP", amount_paise: 100_000_000, min_pct_bps: 9600,
});
await sx.orders.get(order!.id!);

key = ScripxClient.new_idempotency_key()
sx.orders.create(side="sell", scheme="RODTEP", amount_paise=100_000_000,
                 min_pct_bps=9600, idempotency_key=key)

const key = Scripx.newIdempotencyKey();
await sx.orders.create({ side: "sell", scheme: "RODTEP", amount_paise: 100_000_000,
                         min_pct_bps: 9600, idempotencyKey: key });

for credit in sx.credits.iter("0123456789"):        # follows next_cursor for you
    if credit["sellable"]:
        q = sx.quotes.sell(scrip_no=credit["scrip_no"])
        print(credit["scrip_no"], q["price_bps"])

for await (const credit of sx.credits.iterate("0123456789")) { // follows next_cursor for you
  if (credit.sellable) {
    const q = await sx.quotes.sell({ scrip_no: credit.scrip_no });
    console.log(credit.scrip_no, q.price_bps);
  }
}

sx.firms.create(iec="0123456789", name="Acme Exports", role="exporter")
res = sx.firms.verify("0123456789", registration_id="ICE…", password="…")
if res.get("next") == "authorize":
    sx.firms.authorize("0123456789", code="123456")   # one-time code sent to the firm

await sx.firms.create({ iec: "0123456789", name: "Acme Exports", role: "exporter" });
const res = await sx.firms.verify("0123456789", { registration_id: "ICE…", password: "…" });
if (res.next === "authorize") {
  await sx.firms.authorize("0123456789", { code: "123456" }); // one-time code sent to the firm
}

reg = sx.webhooks.register(url="https://example.com/hooks/scripx", event="settlement.settled")
signing_secret = reg["signing_secret"]              # shown once, store it

# in your receiver:
from scripx import verify_webhook
ok = verify_webhook(signing_secret, raw_body, request.headers["X-ScripX-Signature"])

const reg = await sx.webhooks.register({ url: "https://example.com/hooks/scripx", event: "settlement.settled" });
const signingSecret = reg.signing_secret!;          // shown once, store it

// in your receiver:
import { verifyWebhook } from "@scripx/sdk";
const ok = await verifyWebhook(signingSecret, rawBody, req.headers["x-scripx-signature"]);

sx.statements.get("mtd")                            # your draft bill for the period
sx.earnings.get()                                   # desk P&L + withdrawable payable
export = sx.audit.export("all")                     # tamper-evident event log + chain digest

await sx.statements.get("mtd");                     // your draft bill for the period
await sx.earnings.get();                            // desk P&L + withdrawable payable
const auditExport = await sx.audit.export("all");   // tamper-evident event log + chain digest

from scripx import ScripxError, AuthError, RateLimitError, ValidationError

try:
    sx.orders.create(side="sell", scheme="RODTEP", amount_paise=100_000_000, min_pct_bps=9600)
except RateLimitError as e:
    ...   # e.retry_after seconds; the SDK already retried within max_retries
except ValidationError as e:
    print(e.code, e.message, e.detail)
except AuthError as e:
    print("check your key or scopes:", e.message)
except ScripxError as e:
    print("request", e.request_id, "failed:", e.message)

import { ScripxError, AuthError, RateLimitError, ValidationError } from "@scripx/sdk";

try {
  await sx.orders.create({ side: "sell", scheme: "RODTEP", amount_paise: 100_000_000, min_pct_bps: 9600 });
} catch (e) {
  if (e instanceof RateLimitError) { /* e.retryAfter seconds */ }
  else if (e instanceof ValidationError) console.log(e.code, e.message, e.detail);
  else if (e instanceof AuthError) console.log("check your key or scopes:", e.message);
  else if (e instanceof ScripxError) console.log("request", e.requestId, "failed:", e.message);
  else throw e;
}

spec = sx.openapi()

const spec = await sx.openapi();

curl https://api.scripxhq.com/v1/openapi.json -o scripx-openapi.json