GET api/Brokerage/FinanceCalculator/InitialData/{brokerageId}

Retrieve the initial state for PL broker calculator. Available for PL broker users. Does not require authentication

Request Information

URI Parameters

Name	Description	Type	Additional information
brokerageId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Possible error responses: 1. Invalid brokerage id {"brokerageApiKey": "4ac9648d-02e0-444c-b858-600baa85425c", "ErrorMessage": "The provided brokerageApiKey does not exist."}

FinanceCalculatorBrokerageInitialData

Name	Type	Additional information
BrokerageId	globally unique identifier	None.
MinPrice	decimal number	None.
MaxPrice	decimal number	None.
StepSizePrice	integer	None.
StepCountPrice	integer	None.
MiddleElementPrice	decimal number	None.
MinTerm	integer	None.
MaxTerm	integer	None.
StepSizeTerm	integer	None.
StepCountTerm	integer	None.
MiddleElementTerm	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "BrokerageId": "e269801d-55d9-42d6-a812-63cdcb9ed9e6",
  "MinPrice": 2.0,
  "MaxPrice": 3.0,
  "StepSizePrice": 4,
  "StepCountPrice": 5,
  "MiddleElementPrice": 6.0,
  "MinTerm": 7,
  "MaxTerm": 8,
  "StepSizeTerm": 9,
  "StepCountTerm": 10,
  "MiddleElementTerm": 11
}

text/html

Sample:

{"BrokerageId":"e269801d-55d9-42d6-a812-63cdcb9ed9e6","MinPrice":2.0,"MaxPrice":3.0,"StepSizePrice":4,"StepCountPrice":5,"MiddleElementPrice":6.0,"MinTerm":7,"MaxTerm":8,"StepSizeTerm":9,"StepCountTerm":10,"MiddleElementTerm":11}

application/xml, text/xml

Sample:

<FinanceCalculatorBrokerageInitialData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">
  <BrokerageId>e269801d-55d9-42d6-a812-63cdcb9ed9e6</BrokerageId>
  <MaxPrice>3</MaxPrice>
  <MaxTerm>8</MaxTerm>
  <MiddleElementPrice>6</MiddleElementPrice>
  <MiddleElementTerm>11</MiddleElementTerm>
  <MinPrice>2</MinPrice>
  <MinTerm>7</MinTerm>
  <StepCountPrice>5</StepCountPrice>
  <StepCountTerm>10</StepCountTerm>
  <StepSizePrice>4</StepSizePrice>
  <StepSizeTerm>9</StepSizeTerm>
</FinanceCalculatorBrokerageInitialData>