Skip to main content
POST
/
api
/
jpx
/
equities
/
rankings
/jpx/equities/rankings
curl --request POST \
  --url https://api.anysite.io/api/jpx/equities/rankings \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "market": "all"
}
'
[
  {
    "code": "<string>",
    "name": "<string>",
    "market": "<string>",
    "@type": "@jpx_ranked_stock",
    "turnover": "<string>",
    "price": 123,
    "change": 123
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Number of ranked stocks to return

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

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
market
enum<string>
default:all

Market segment to retrieve rankings for

Available options:
prime,
standard,
growth,
all

Response

Successful Response

​
code
string
required
​
name
string
required
​
market
string
required
​
@type
string
default:@jpx_ranked_stock
​
turnover
string | null
​
price
number | null
​
change
number | null