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

# Group positions

> Read your ScripX book aggregated by scheme and group company: the ready-made input for the intra-group netting plan.

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

Your book aggregated by company and scheme, shaped exactly as [`POST /v1/group/net-plan`](/api-reference/group/net-plan) expects it. Requires the `orders:read` scope.

### Request example

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

### Response example

```json theme={"dark"}
{
  "party_iec": "0512345678",
  "positions": [
    {"iec": "0512345678", "scheme": "RODTEP", "net_paise": 100000000},
    {"iec": "0587654321", "scheme": "RODTEP", "net_paise": -60000000}
  ]
}
```

Feed `positions` straight into the netting plan.

### Errors

* `401` / `403` / `429`, the standard [auth errors](/authentication#authentication-errors).

**Terms used here:** [scheme](/annexure/terminology#scheme), [IEC](/annexure/terminology#iec), [paise](/annexure/terminology#paise), [position](/annexure/terminology#position), [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

* [Netting plan](/api-reference/group/net-plan)


## OpenAPI

````yaml GET /v1/group/positions
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/group/positions:
    get:
      tags:
        - Group
      summary: Your book aggregated by scheme (feeds net-plan)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupPositions'
        '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:
    GroupPositions:
      type: object
      properties:
        party_iec:
          type: string
        positions:
          type: array
          items:
            type: object
            properties:
              iec:
                type: string
              scheme:
                type: string
              net_paise:
                type: integer
    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.

````