Get one credit - ScripX Docs

Get one credit of a connected firm

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

import requests

url = "https://api.scripxhq.com/v1/firms/{iec}/credits/{scrip_no}"

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/firms/{iec}/credits/{scrip_no}', 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/firms/{iec}/credits/{scrip_no}",
  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/firms/{iec}/credits/{scrip_no}"

	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/firms/{iec}/credits/{scrip_no}")
  .header("X-ScripX-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/firms/{iec}/credits/{scrip_no}")

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

{
  "credit": {
    "scrip_no": "<string>",
    "face_paise": 123,
    "balance_paise": 123,
    "issue_date": "<string>",
    "expiry_date": "<string>",
    "sellable": true,
    "lifecycle": [
      {
        "at": "<string>"
      }
    ]
  }
}

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

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

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

GET

firms

{iec}

credits

{scrip_no}

Get one credit of a connected firm

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

import requests

url = "https://api.scripxhq.com/v1/firms/{iec}/credits/{scrip_no}"

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/firms/{iec}/credits/{scrip_no}', 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/firms/{iec}/credits/{scrip_no}",
  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/firms/{iec}/credits/{scrip_no}"

	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/firms/{iec}/credits/{scrip_no}")
  .header("X-ScripX-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/firms/{iec}/credits/{scrip_no}")

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

{
  "credit": {
    "scrip_no": "<string>",
    "face_paise": 123,
    "balance_paise": 123,
    "issue_date": "<string>",
    "expiry_date": "<string>",
    "sellable": true,
    "lifecycle": [
      {
        "at": "<string>"
      }
    ]
  }
}

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

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

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

One credit in full, the detail read behind a row of the inventory list. It carries a lifecycle timeline your platform can render like a status tracker, the same shape a portfolio UI shows a client. Requires the firms scope and a connected firm.

Request example

curl "https://api.scripxhq.com/v1/firms/0512345678/credits/SCRIP204188" \
  -H "X-ScripX-Key: <YOUR_API_KEY>"

Response example

{
  "credit": {
    "scrip_no": "SCRIP204188",
    "scheme": "RODTEP",
    "face_paise": 100000000,
    "balance_paise": 100000000,
    "issue_date": "2026-04-01",
    "expiry_date": "2027-03-31",
    "status": "issued",
    "sellable": true,
    "lifecycle": [
      { "stage": "issued", "state": "done", "at": "2026-04-01" },
      { "stage": "available", "state": "current" },
      { "stage": "sold", "state": "upcoming" },
      { "stage": "settled", "state": "upcoming" }
    ]
  }
}

lifecycle stages are issued → available → sold → settled for a credit on its way to sale, with an alternate tail (utilized, expired, cancelled) once a credit leaves that path. Each stage’s state is done, current or upcoming, so a tracker renders straight from the array.

Errors

404 not_found, the firm does not hold this credit.
409 conflict, the firm is not connected.

Terms used here: scrip_no, scheme, face value, balance, expiry, connection state, paise, sellable, API key. Full list in the terminology annexure.

Next steps

Quote this credit by scrip_no.

Authorizations

X-ScripX-Key

string

header

required

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

Path Parameters

iec

string

required

scrip_no

string

required

Response

credit

object

one duty credit held by the firm, its full lifecycle record

Show child attributes

List a firm's credits Get a firm quote

⌘I

​Request example

​Response example

​Errors

​Next steps

Authorizations

Path Parameters

Response

Request example

Response example

Errors

Next steps