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

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"
}
'

200

[
  {
    "name": "<string>",
    "in": "<string>",
    "required": true,
    "type": "<string>",
    "format": "<string>",
    "description": "<string>",
    "example": "<string>",
    "enum": [
      "<string>"
    ]
  }
]

Authorizations

X-Api-Key · string · header · required

API Key authentication. Include your API key in the X-Api-Key header for all requests.

Body

application/json

path · string · required

Partial endpoint path (e.g., 'derivatives/Price' or '{asset}/derivatives/Price'). Matching is case-insensitive.

Example:

"derivatives/Price"

Response

200

application/json

Endpoint parameters retrieved successfully

name · string

Parameter name

in · string

Parameter location (path, query, header, body)

required · boolean

Whether the parameter is required

type · string

Parameter type (string, integer, number, boolean, etc.)

format · string

Parameter format (date-time, int32, double, etc.)

description · string

Parameter description

example · string

Example value

enum · string[]

Allowed values (for enum types)