Get the program for a symbol

Required scope: read

GET /api/v1/nsr/programs/{symbol_id}

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/nsr/programs/{symbol_id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "depth": 1,
  "program": "string",
  "symbol_id": 1001
}

Required scope: read

Path parameters

symbol_id · integer (int64) · required

Symbol ID

Response

ProgramResponse

depth · integer · required

Program depth

program · string · required

Program representation (simplified)

symbol_id · integer (int64) · required

Symbol ID

Status codes

Code	Meaning
200	Program found
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	Program not found
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/nsr/programs/{symbol_id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "depth": 1,
  "program": "string",
  "symbol_id": 1001
}