Netting plan - ScripX Docs

Minimal intra-group netting plan

curl --request POST \
  --url https://api.scripxhq.com/v1/group/net-plan \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "positions": [
    {
      "iec": "<string>",
      "scheme": "<string>",
      "net_paise": 123
    }
  ]
}
'

import requests

url = "https://api.scripxhq.com/v1/group/net-plan"

payload = { "positions": [
        {
            "iec": "<string>",
            "scheme": "<string>",
            "net_paise": 123
        }
    ] }
headers = {
    "X-ScripX-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-ScripX-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({positions: [{iec: '<string>', scheme: '<string>', net_paise: 123}]})
};

fetch('https://api.scripxhq.com/v1/group/net-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripxhq.com/v1/group/net-plan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'positions' => [
        [
                'iec' => '<string>',
                'scheme' => '<string>',
                'net_paise' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ScripX-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/group/net-plan"

	payload := strings.NewReader("{\n  \"positions\": [\n    {\n      \"iec\": \"<string>\",\n      \"scheme\": \"<string>\",\n      \"net_paise\": 123\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ScripX-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripxhq.com/v1/group/net-plan")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"positions\": [\n    {\n      \"iec\": \"<string>\",\n      \"scheme\": \"<string>\",\n      \"net_paise\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/group/net-plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"positions\": [\n    {\n      \"iec\": \"<string>\",\n      \"scheme\": \"<string>\",\n      \"net_paise\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "summary": {},
  "transfers": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

POST

group

net-plan

Minimal intra-group netting plan

curl --request POST \
  --url https://api.scripxhq.com/v1/group/net-plan \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "positions": [
    {
      "iec": "<string>",
      "scheme": "<string>",
      "net_paise": 123
    }
  ]
}
'

import requests

url = "https://api.scripxhq.com/v1/group/net-plan"

payload = { "positions": [
        {
            "iec": "<string>",
            "scheme": "<string>",
            "net_paise": 123
        }
    ] }
headers = {
    "X-ScripX-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-ScripX-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({positions: [{iec: '<string>', scheme: '<string>', net_paise: 123}]})
};

fetch('https://api.scripxhq.com/v1/group/net-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripxhq.com/v1/group/net-plan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'positions' => [
        [
                'iec' => '<string>',
                'scheme' => '<string>',
                'net_paise' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ScripX-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/group/net-plan"

	payload := strings.NewReader("{\n  \"positions\": [\n    {\n      \"iec\": \"<string>\",\n      \"scheme\": \"<string>\",\n      \"net_paise\": 123\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ScripX-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripxhq.com/v1/group/net-plan")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"positions\": [\n    {\n      \"iec\": \"<string>\",\n      \"scheme\": \"<string>\",\n      \"net_paise\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/group/net-plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"positions\": [\n    {\n      \"iec\": \"<string>\",\n      \"scheme\": \"<string>\",\n      \"net_paise\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "summary": {},
  "transfers": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

Group netting is executed through the cross desk, which must be active on your key. Write to amin@eximfiles.io to have it enabled.

For groups with several importing and exporting entities: pass each company’s net position per scheme and get back the minimal set of internal transfers that squares the group, so only the true residual goes to market. Requires the orders:read scope; the plan is a computation, it moves nothing.

Request example

curl -X POST "https://api.scripxhq.com/v1/group/net-plan" \
  -H "X-ScripX-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"positions": [
        {"iec": "0512345678", "scheme": "RODTEP", "net_paise": 100000000},
        {"iec": "0587654321", "scheme": "RODTEP", "net_paise": -60000000}
      ]}'

Positive net_paise is surplus credit (a seller), negative is demand (a buyer).

Response example

{
  "summary": {"internal_paise": 60000000, "residual_paise": 40000000},
  "transfers": [
    {"from_iec": "0512345678", "to_iec": "0587654321", "scheme": "RODTEP", "amount_paise": 60000000}
  ]
}

₹6,00,000 nets between the two entities; only ₹4,00,000 of surplus goes to market. Execute each internal transfer as an intra-group cross at prices you set, after reading the full economics on the cross quote. See the enterprise guide for the flow end to end.

Errors

422 unprocessable, empty or malformed positions.

Terms used here: scheme, IEC, paise, residual, position, cross, group netting, API key, scope. Full list in the terminology annexure.

Next steps

Group positions computes the input book for you.
Cross desk to execute the plan’s transfers.

Authorizations

X-ScripX-Key

string

header

required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Body

application/json

positions

object[]

required

Show child attributes

Response

summary

object

transfers

object[]

List positions Group positions

⌘I

​Request example

​Response example

​Errors

​Next steps

Authorizations

Body

Response

Request example

Response example

Errors

Next steps