Skip to main content
POST
/
api
/
jpx
/
equities
/
halted
/jpx/equities/halted
curl --request POST \
  --url https://api.anysite.io/api/jpx/equities/halted \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300
}
'
[
  {
    "code": "<string>",
    "name": "<string>",
    "@type": "@jpx_halted_security",
    "date": "<string>",
    "halt_start": "<string>",
    "halt_end": "<string>",
    "resume_time": "<string>",
    "reason": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Number of halted security entries to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

code
string
required
name
string
required
@type
string
default:@jpx_halted_security
date
string | null
halt_start
string | null
halt_end
string | null
resume_time
string | null
reason
string | null