POST
/
var
/
submit_job
/
historical
/
{data_format}
curl --request POST \
  --url https://5uftseufe1.execute-api.us-east-2.amazonaws.com/prod/var/submit_job/historical/{data_format} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "numScenarios": 123,
  "timeHorizonDays": 123,
  "confidenceLevels": [
    123
  ],
  "volatilityLookbackDays": 123,
  "ewmaDecayFactor": 123,
  "volatilityMultiplier": 123,
  "settings": {
    "startDate": "<string>",
    "endDate": "<string>",
    "addedDates": [
      "<string>"
    ],
    "excludedDates": [
      "<string>"
    ]
  },
  "portfolio": {
    "futures": [
      {
        "ticker": "<string>",
        "type": "long",
        "quantity": 123
      }
    ],
    "stocks": [
      {
        "ticker": "<string>",
        "type": "long",
        "quantity": 123
      }
    ],
    "options": [
      {
        "ticker": "<string>",
        "type": "long",
        "style": "european",
        "put": "call",
        "strike": 123,
        "maturity": "<string>",
        "quantity": 123
      }
    ],
    "bonds": [
      {
        "faceValue": 123,
        "interestRate": 123,
        "maturity": "<string>",
        "quantity": 123
      }
    ]
  }
}'
{
  "job_id": "<string>",
  "status": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Server authentication header of the form x-api-key: <api-key>, where <api-key> is your auth token

Path Parameters

​
data_format
enum<string>
required

Format of the portfolio data

Available options:
fpml,
csv,
json,
xml,
yaml

Body

application/json

Job to submit to the server

The body is of type object.

Response

200
application/json

server response

The response is of type object.