> ## 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.

# Market snapshot

> Read the ScripX market depth snapshot for a duty credit scrip scheme: aggregate supply on offer and duty demand, per scheme.

The aggregate depth of one scheme's market: face value on offer and duty demand seeking cover. Requires the `market:read` scope. Each scheme is priced independently, so read the scheme you trade, not a proxy.

### Request example

```bash theme={"dark"}
curl "https://api.scripxhq.com/v1/market/RODTEP" \
  -H "X-ScripX-Key: <YOUR_API_KEY>"
```

`scheme` is `RODTEP` or `ROSCTL` (see [Schemes](/annexure/schemes)).

### Response example

```json theme={"dark"}
{
  "scheme": "RODTEP",
  "depth": {
    "supply_paise": 2400000000,
    "demand_paise": 1900000000
  },
  "asof": "2026-07-24T14:30:00+05:30"
}
```

Depth is context, not a commitment. For a tradable price, take a [firm quote](/api-reference/trading/quote): quotes are firm, snapshots are weather.

### Errors

* `400 bad_request`, unknown scheme value.

**Terms used here:** [scheme](/annexure/terminology#scheme), [face value](/annexure/terminology#face-value), [paise](/annexure/terminology#paise), [firm quote](/annexure/terminology#firm-quote), [API key](/annexure/terminology#api-key), [scope](/annexure/terminology#scope). Full list in the [terminology annexure](/annexure/terminology).

### Next steps

* [Live stream](/api-reference/trading/market-stream), the same snapshot pushed over SSE.
* [Firm quote](/api-reference/trading/quote) when a level is worth trading.


## OpenAPI

````yaml GET /v1/market/{scheme}
openapi: 3.1.0
info:
  title: ScripX Partner API
  version: 1.2.0
  description: >-
    Automate duty-credit-scrip trading: quote, order, positions, market,
    webhooks. Auth: `X-ScripX-Key: scripx_live_…`. Money = integer paise; price
    = bps of face.
  contact:
    name: ScripX API Support
    email: amin@eximfiles.io
    url: https://scripxhq.com
servers:
  - url: https://api.scripxhq.com
    description: >-
      Production and sandbox share one host; a scripx_test_ key selects the
      sandbox.
security:
  - ApiKeyAuth: []
tags:
  - name: Firms
    description: >-
      client-firm lifecycle: register, verify, authorize, credits, update,
      offboard
  - name: Trading
    description: quote, orders, positions, market
  - name: Group
    description: intra-group netting + positions (enterprise/broker)
  - name: Cross
    description: 'broker cross-desk: block deals + intra-group transfers'
  - name: Webhooks
    description: event subscriptions + delivery
  - name: Account
    description: usage + metering
  - name: Keys
    description: self-serve scoped child keys (sub-accounts)
paths:
  /v1/market/{scheme}:
    get:
      tags:
        - Trading
      summary: Market snapshot
      parameters:
        - name: scheme
          in: path
          required: true
          schema:
            type: string
            enum:
              - RODTEP
              - ROSCTL
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Market'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Market:
      type: object
      description: aggregate depth snapshot; for a tradable price take a quote
      properties:
        scheme:
          type: string
        depth:
          type: object
          properties:
            supply_paise:
              type: integer
              description: aggregate face on offer
            demand_paise:
              type: integer
              description: aggregate duty demand
        asof:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: stable machine code
          enum:
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - conflict
            - unprocessable
            - rate_limited
            - internal
        message:
          type: string
        detail:
          type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-ScripX-Key
      description: >-
        Your API key, e.g. `scripx_live_…`. Bound to one firm; tenant isolation
        is enforced.

````