Price a cross

Price a cross (block deal / transfer)

curl --request POST \
  --url https://api.scripxhq.com/v1/cross/quote \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "scheme": "<string>",
  "amount_paise": 123,
  "buy_price_bps": 123,
  "sell_price_bps": 123
}
'

import requests

url = "https://api.scripxhq.com/v1/cross/quote"

payload = {
    "scheme": "<string>",
    "amount_paise": 123,
    "buy_price_bps": 123,
    "sell_price_bps": 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({scheme: '<string>', amount_paise: 123, buy_price_bps: 123, sell_price_bps: 123})
};

fetch('https://api.scripxhq.com/v1/cross/quote', 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/cross/quote",
  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([
    'scheme' => '<string>',
    'amount_paise' => 123,
    'buy_price_bps' => 123,
    'sell_price_bps' => 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/cross/quote"

	payload := strings.NewReader("{\n  \"scheme\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\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/cross/quote")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scheme\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross/quote")

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  \"scheme\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}"

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

{}

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

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

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

POST

cross

quote

Price a cross (block deal / transfer)

curl --request POST \
  --url https://api.scripxhq.com/v1/cross/quote \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "scheme": "<string>",
  "amount_paise": 123,
  "buy_price_bps": 123,
  "sell_price_bps": 123
}
'

import requests

url = "https://api.scripxhq.com/v1/cross/quote"

payload = {
    "scheme": "<string>",
    "amount_paise": 123,
    "buy_price_bps": 123,
    "sell_price_bps": 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({scheme: '<string>', amount_paise: 123, buy_price_bps: 123, sell_price_bps: 123})
};

fetch('https://api.scripxhq.com/v1/cross/quote', 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/cross/quote",
  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([
    'scheme' => '<string>',
    'amount_paise' => 123,
    'buy_price_bps' => 123,
    'sell_price_bps' => 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/cross/quote"

	payload := strings.NewReader("{\n  \"scheme\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\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/cross/quote")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scheme\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross/quote")

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  \"scheme\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}"

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

{}

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

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

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

Cross desk endpoints require the cross desk to be active on your key. Write to amin@eximfiles.io to have it enabled.

The dry run before a cross: 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

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

Response example

{
  "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, paise, bps, platform fee, cross, group netting, API key, scope. Full list in the terminology annexure.

Next steps

Prepare the cross

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

kind

enum<string>

Available options:

external,

intra_group

scheme

string

amount_paise

integer

buy_price_bps

integer

sell_price_bps

integer

Response

economics: gross/net spread, platform fee, buyer-pays, seller-gets (paise)

Group positions Prepare a cross

⌘I

Overview

Firms

Scrips & credits

Quotes & orders

Positions

Cross desk

Market & rates

Statements, earnings & usage

Settings

API keys

Webhooks

Audit

Request example

Response example

Errors

Next steps

Authorizations

Body

Response

​Request example

​Response example

​Errors

​Next steps

Authorizations

Body

Response

Request example

Response example

Errors

Next steps