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

# Price a cross

> Price a ScripX cross before preparing it: the economics of a block deal or intra-group transfer, gross and net spread, platform fee, buyer pays and seller gets. Terms are defined in the terminology annexure.

<Note>
  Cross desk endpoints require the cross desk to be active on your key. Write to [amin@eximfiles.io](mailto:amin@eximfiles.io) to have it enabled.
</Note>

The dry run before a [cross](/api-reference/cross/create): pass the deal shape, read the full economics, commit to nothing. Requires the `quote` scope.

On a cross **you set both prices**. The buy-side firm pays `buy_price_bps`, the sell-side firm receives `sell_price_bps`, and the gap is `gross_spread_paise`. `platform_fee_paise` is ScripX's commission on the deal and `net_spread_paise` is what remains to the desk. Every one of those numbers is returned before you commit to anything.

### Request example

```bash theme={"dark"}
curl -X POST "https://api.scripxhq.com/v1/cross/quote" \
  -H "X-ScripX-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"kind": "external", "scheme": "RODTEP", "amount_paise": 500000000,
       "buy_price_bps": 9700, "sell_price_bps": 9640}'
```

`kind` is `external` (a block deal you brokered) or `intra_group` (moving credit between your own entities, e.g. from a [netting plan](/api-reference/group/net-plan)).

### Response example

```json theme={"dark"}
{
  "amount_paise": 500000000,
  "buyer_pays_paise": 485000000,
  "seller_gets_paise": 482000000,
  "gross_spread_paise": 3000000,
  "platform_fee_paise": 600000,
  "net_spread_paise": 2400000
}
```

`net_spread_paise` is the desk's take: the gross spread, net of ScripX's commission. Nothing about the deal's economics is discovered after the fact.

### Errors

* `422 unprocessable`, prices out of range or buy below sell.

**Terms used here:** [scheme](/annexure/terminology#scheme), [paise](/annexure/terminology#paise), [bps](/annexure/terminology#basis-point), [platform fee](/annexure/terminology#platform-fee-and-net-spread), [cross](/annexure/terminology#cross-block-deal), [group netting](/annexure/terminology#group-netting), [API key](/annexure/terminology#api-key), [scope](/annexure/terminology#scope). Full list in the [terminology annexure](/annexure/terminology).

### Next steps

* [Prepare the cross](/api-reference/cross/create)


## OpenAPI

````yaml POST /v1/cross/quote
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/cross/quote:
    post:
      tags:
        - Cross
      summary: Price a cross (block deal / transfer)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrossQuoteRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossQuote'
        '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:
    CrossQuoteRequest:
      type: object
      properties:
        kind:
          type: string
          enum:
            - external
            - intra_group
        scheme:
          type: string
        amount_paise:
          type: integer
        buy_price_bps:
          type: integer
        sell_price_bps:
          type: integer
    CrossQuote:
      type: object
      description: >-
        economics: gross/net spread, platform fee, buyer-pays, seller-gets
        (paise)
    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.

````