> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scripxhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> One REST API for India's duty credit scrip market: quote a firm price, place the order, settle the same day against a bank UTR. Sell RoDTEP and RoSCTL scrips, cover customs duty below face value, run a broker desk, net a multi-entity group, or embed the whole flow in your own product.

ScripX is the exchange for India's duty credit scrips, the RoDTEP and RoSCTL credits that pay basic customs duty at face value. Quote a firm price for an exact amount, place the order, and settle the same business day (T+0) against a bank UTR, with provenance checked on every scrip before it can trade.

This is **one REST API over the whole product**. JSON over HTTPS, one `X-ScripX-Key` header, the same contract in sandbox and production. Whether you sell a single matured scrip, cover a Bill of Entry, run a broker book, square a group of companies, or embed all of it in your own product, you are calling the same endpoints.

## Choose your path

<CardGroup cols={2}>
  <Card title="Sell scrips" icon="arrow-up-from-bracket" href="/guides/exporter-sell">
    **Exporters.** List a firm's matured credits, take a firm quote per scrip, sell with a price floor, and get paid with a UTR the same day.
  </Card>

  <Card title="Buy scrips" icon="arrow-down-to-bracket" href="/guides/importer-buy">
    **Importers.** Quote a duty requirement, receive the whole-scrip bundle that covers it, and fund customs duty below face value.
  </Card>

  <Card title="Run a desk" icon="briefcase" href="/guides/broker-desk">
    **Brokers and desks.** Price a block deal, then prepare, fund and release it as separate deliberate steps, and read your earnings.
  </Card>

  <Card title="Net a group" icon="sitemap" href="/guides/enterprise-group">
    **Enterprises.** Read positions across every entity, net internal surplus against internal demand, and take only the residual to market.
  </Card>

  <Card title="Embed ScripX" icon="puzzle-piece" href="/guides/platform-embed">
    **Platforms.** Onboard client firms from your own UI, mint a scoped key per service, and reconcile the whole book with one audit trail.
  </Card>

  <Card title="Quick start" icon="rocket" href="/quick-start">
    **Everyone.** Market snapshot to firm quote to a placed order, in five curl calls.
  </Card>
</CardGroup>

## What the API gives you

* **A firm price, not an indication.** [`POST /v1/quote`](/api-reference/trading/quote) returns one binding price for an exact scrip or an exact duty requirement, good until a stated `valid_until`, with `all_in_paise` as the only number that changes hands.
* **Orders that cannot slip.** A sell order carries `min_pct_bps` as a floor, a buy order carries `max_pct_bps` as a ceiling, and an `Idempotency-Key` makes any retry safe.
* **Delivery versus payment.** Title and money move together or neither moves, and the seller payout carries a bank UTR on the same business day.
* **Provenance on every scrip.** A credit is quotable only once it has been screened. `sellable: true` on [a firm's credits](/api-reference/firms/credits) is the flag to trade on.
* **Status without polling.** [Signed webhooks](/webhooks) for `order.matched`, `settlement.settled` and `payout.sent`, with retries, dead-letters and replay.
* **A record that reconciles.** [Statements](/api-reference/account/statements), [earnings](/api-reference/account/earnings) and a hash-chained [audit export](/api-reference/account/audit-export) your auditor can verify offline.

## The lifecycle at a glance

<Steps>
  <Step title="Connect the firm">
    [Register the firm](/api-reference/firms/create) with its IEC, [verify](/api-reference/firms/verify) it under its own mandate, and complete with the one-time [authorization code](/api-reference/firms/authorize). A firm trades once its state is `connected`.
  </Step>

  <Step title="Quote">
    Read the [market snapshot](/api-reference/trading/market) or the [live stream](/api-reference/trading/market-stream), then take a [firm quote](/api-reference/trading/quote) for the exact scrip or the exact requirement.
  </Step>

  <Step title="Order">
    [Place the order](/api-reference/trading/orders-create) at your limit with an `Idempotency-Key`, or [batch up to 500](/api-reference/trading/orders-batch). Desks book block deals and intra-group transfers on the [cross desk](/api-reference/cross/create).
  </Step>

  <Step title="Settle and reconcile">
    Poll [positions](/api-reference/trading/positions) or take the [webhook](/api-reference/webhooks/register). Settlement completes delivery versus payment, the payout carries a UTR, and [statements](/api-reference/account/statements) plus the [audit export](/api-reference/account/audit-export) close the loop.
  </Step>
</Steps>

## Base URL and environments

<CodeGroup>
  ```bash Production theme={"dark"}
  https://api.scripxhq.com
  ```

  ```bash Sandbox theme={"dark"}
  https://api.scripxhq.com   # same host, use a scripx_test_… key
  ```
</CodeGroup>

The environment lives in the key, not the host. `scripx_live_…` is production; `scripx_test_…` is the sandbox, where the full lifecycle runs with simulated money and nothing real ever moves. Build your entire UI there first: see [Environments](/environments). The machine-readable contract is public at [`GET /v1/openapi.json`](/api-reference/introduction).

## Three conventions that hold everywhere

Money is **integer paise**, price is **bps of face value**, timestamps are **ISO 8601 (IST)**. Learn them once and every payload reads itself. Worked examples are in the [Money and price annexure](/annexure/money-and-price), and every term the API uses is defined in the [Terminology annexure](/annexure/terminology).

## Learn the market

<CardGroup cols={3}>
  <Card title="What is a scrip?" icon="circle-info" href="/what-is-a-scrip">
    The instrument itself: how a claim becomes a credit, and what the credit can pay.
  </Card>

  <Card title="RoDTEP explained" icon="ship" href="/concepts/rodtep-scheme">
    What the scheme remits, how rates are notified, and who earns them.
  </Card>

  <Card title="RoSCTL explained" icon="shirt" href="/concepts/rosctl-scheme">
    The apparel and made-ups scheme, and how it differs from RoDTEP.
  </Card>

  <Card title="Price and discount" icon="percent" href="/concepts/scrip-price-discount">
    What moves the discount, and how bps convert to rupees.
  </Card>

  <Card title="Core concepts" icon="book-open" href="/core-concepts">
    Scrips, the reference rate, provenance, DvP settlement and the UTR.
  </Card>

  <Card title="Glossary" icon="book-open-cover" href="/concepts/glossary">
    Every term in the market, with the API field that carries it.
  </Card>
</CardGroup>

## Build the integration

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    The `X-ScripX-Key` header, scopes, child keys, and the rate limit headers on every response.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/errors">
    The flat error body, every status code, and the stable `code` values to branch on.
  </Card>

  <Card title="Webhooks" icon="bolt" href="/webhooks">
    Signature verification, delivery headers, retries, dead-letters and replay.
  </Card>

  <Card title="SDKs and tools" icon="cubes" href="/sdks">
    Python and TypeScript clients, webhook verification helpers, and the live OpenAPI spec.
  </Card>
</CardGroup>

## Need help?

<Card title="Write to support" icon="envelope" href="mailto:amin@eximfiles.io">
  Support is first-party, no ticket maze. Include your key prefix (never the full key) and, for a specific call, the response body you received.
</Card>

ScripX is a product of Eximfiles, operated by Dreamfuel Technologies Private Limited.