Get endpoint parameters
curl --request POST \
--url https://api.alphractal.com/endpoints/parameters \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"path": "derivatives/Price"
}
'import requests
url = "https://api.alphractal.com/endpoints/parameters"
payload = { "path": "derivatives/Price" }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: 'derivatives/Price'})
};
fetch('https://api.alphractal.com/endpoints/parameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"name": "<string>",
"in": "<string>",
"required": true,
"type": "<string>",
"format": "<string>",
"description": "<string>",
"example": "<string>",
"enum": [
"<string>"
]
}
]Metadata
Get endpoint parameters
Retrieves all available parameters for an endpoint by providing a partial endpoint path. Useful for discovering what parameters an endpoint accepts. Path matching is case-insensitive.
POST
/
endpoints
/
parameters
Get endpoint parameters
curl --request POST \
--url https://api.alphractal.com/endpoints/parameters \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"path": "derivatives/Price"
}
'import requests
url = "https://api.alphractal.com/endpoints/parameters"
payload = { "path": "derivatives/Price" }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: 'derivatives/Price'})
};
fetch('https://api.alphractal.com/endpoints/parameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"name": "<string>",
"in": "<string>",
"required": true,
"type": "<string>",
"format": "<string>",
"description": "<string>",
"example": "<string>",
"enum": [
"<string>"
]
}
]Authorizations
API Key authentication. Include your API key in the X-Api-Key header for all requests.
Body
application/json
Partial endpoint path (e.g., 'derivatives/Price' or '{asset}/derivatives/Price'). Matching is case-insensitive.
Example:
"derivatives/Price"
Response
Endpoint parameters retrieved successfully
Parameter name
Parameter location (path, query, header, body)
Whether the parameter is required
Parameter type (string, integer, number, boolean, etc.)
Parameter format (date-time, int32, double, etc.)
Parameter description
Example value
Allowed values (for enum types)