Skip to main content
POST
/
api
/
jpx
/
equities
/
index-returns
/jpx/equities/index-returns
curl --request POST \
  --url https://api.anysite.io/api/jpx/equities/index-returns \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "period": "weekly"
}
'
[
  {
    "date": "<string>",
    "index_name": "<string>",
    "@type": "@jpx_index_return",
    "index_code": "<string>",
    "level": 123,
    "change": 123,
    "change_percent": 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 index return entries to return

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

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
period
enum<string>
default:weekly

Return period

Available options:
weekly,
monthly

Response

Successful Response

​
date
string
required
​
index_name
string
required
​
@type
string
default:@jpx_index_return
​
index_code
string | null
​
level
number | null
​
change
number | null
​
change_percent
number | null