Get a cross - ScripX Docs

Get one of your crosses

curl --request GET \
  --url https://api.scripxhq.com/v1/cross/{cross_id} \
  --header 'X-ScripX-Key: <api-key>'

import requests

url = "https://api.scripxhq.com/v1/cross/{cross_id}"

headers = {"X-ScripX-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-ScripX-Key': '<api-key>'}};

fetch('https://api.scripxhq.com/v1/cross/{cross_id}', 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/{cross_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/cross/{cross_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-ScripX-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.scripxhq.com/v1/cross/{cross_id}")
  .header("X-ScripX-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross/{cross_id}")

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

request = Net::HTTP::Get.new(url)
request["X-ScripX-Key"] = '<api-key>'

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

{
  "deal": {}
}

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

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

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

GET

cross

{cross_id}

Get one of your crosses

curl --request GET \
  --url https://api.scripxhq.com/v1/cross/{cross_id} \
  --header 'X-ScripX-Key: <api-key>'

import requests

url = "https://api.scripxhq.com/v1/cross/{cross_id}"

headers = {"X-ScripX-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-ScripX-Key': '<api-key>'}};

fetch('https://api.scripxhq.com/v1/cross/{cross_id}', 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/{cross_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/cross/{cross_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-ScripX-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.scripxhq.com/v1/cross/{cross_id}")
  .header("X-ScripX-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross/{cross_id}")

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

request = Net::HTTP::Get.new(url)
request["X-ScripX-Key"] = '<api-key>'

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

{
  "deal": {}
}

{
  "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.

One cross, current state. Requires the orders:read scope. The authoritative read between lifecycle steps and behind webhook hints.

Request example

curl "https://api.scripxhq.com/v1/cross/crs_01HZY…" \
  -H "X-ScripX-Key: <YOUR_API_KEY>"

Response example

{
  "deal": {
    "cross_id": "crs_01HZY…",
    "status": "funded",
    "scheme": "RODTEP",
    "amount_paise": 500000000,
    "buy_price_bps": 9700,
    "sell_price_bps": 9640,
    "rfq": true,
    "note": "July block, as agreed"
  }
}

Errors

404 not_found, no such cross on your desk.

Terms used here: scheme, paise, bps, cross, RFQ, API key, scope, webhook. Full list in the terminology annexure.

Next steps

Settle or confirm, depending on state.

Authorizations

X-ScripX-Key

string

header

required

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

Path Parameters

cross_id

string

required

Response

deal

object

List crosses Fund a cross

⌘I

​Request example

​Response example

​Errors

​Next steps

Authorizations

Path Parameters

Response

Request example

Response example

Errors

Next steps