R | API+

https://jocular-pastelito-5c8054.netlify.app/
Admin
R | API+ is a trading and market data API that provides access to order management, account...
Tokens:500,015
Snippets:5,408
Trust Score:7.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### int REngine::replayExecutions(AccountInfo* _pAccount_, int _iStartSsboe_, int _iEndSsboe_, int* _aiCode_)

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1rengine

Requests a list of all available fills from the infrastructure with a timestamp on or between the range specified by a starting 'second since the beginning of the epoch' (ssboe) and an ending ssboe. Only fills from the current trading day are available. The results are returned via RCallbacks::ExecutionReplay.

```APIDOC
## int REngine::replayExecutions(AccountInfo* _pAccount_, int _iStartSsboe_, int _iEndSsboe_, int* _aiCode_)

### Description
Requests a list of all available fills from the infrastructure with a timestamp on or between the range specified by a starting 'second since the beginning of the epoch' (ssboe) and an ending ssboe. Only fills from the current trading day are available, regardless of how early the starting ssboe is. The returned set of fills will include fills from quotes.

### Method
replayExecutions

### Parameters
- **_pAccount_** (AccountInfo*) - Required - Pointer to the account information for which fills are requested.
- **_iStartSsboe_** (int) - Required - Starting ssboe timestamp. If zero, the time range will not be used and all fills for the current trading day will be returned.
- **_iEndSsboe_** (int) - Required - Ending ssboe timestamp. If zero, the time range will not be used and all fills for the current trading day will be returned.
- **_aiCode_** (int*) - Required - Pointer to an integer that will receive a return code indicating the success or failure of the request.

### Return Value
- **int** - Returns a status code indicating the success or failure of the request.

### Remarks
The beginning of epoch is Jan 1, 1970 00:00:00 GMT.

### See Also
- REngine::replayExecutions()
- RCallbacks::ExecutionReplay()
- ExecutionReplayInfo
```

--------------------------------

### startTimer

Source: https://jocular-pastelito-5c8054.netlify.app/rapiplus_8h_source

Starts a timer.

```APIDOC
## startTimer

### Description
Starts a timer.

### Method
Function

### Signature
`int startTimer(tsNCharcb * const pTimerName, int * aiCode);`

### Parameters
- **pTimerName** (tsNCharcb*) - Timer name.
- **aiCode** (int*) - Output parameter for error code.

### Returns
- **int** - Status code.
```

--------------------------------

### ProductRmsInfo::ProductRmsInfo

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1ProductRmsInfo.html

Constructor that initializes all members to default values.

```APIDOC
## ProductRmsInfo::ProductRmsInfo

### Description
This constructor initializes all of the members. The pData of each tsNCharcb is set to MNM_EMPTY_DATA_ITEM and the iDataLen of each tsNCharcb is set to MNM_EMPTY_DATA_ITEM_LEN. Integer members and double members are initialized to zero. Boolean members are set to false. Pointers (and pointers to arrays) are set to NULL.

### Method
ProductRmsInfo

### Parameters
None

### Returns
None
```

--------------------------------

### EquityOptionStrategyListInfo::EquityOptionStrategyListInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1EquityOptionStrategyListInfo.html

Constructor that initializes all members. Sets pData of each tsNCharcb to MNM_EMPTY_DATA_ITEM, iDataLen to MNM_EMPTY_DATA_ITEM_LEN, integer and double members to zero, boolean members to false, and pointers to NULL.

```APIDOC
## Constructor

### Description
Initializes all members of the EquityOptionStrategyListInfo object.

### Signature
`EquityOptionStrategyListInfo()`

### Parameters
None.

### Remarks
- Each tsNCharcb's pData is set to MNM_EMPTY_DATA_ITEM.
- Each tsNCharcb's iDataLen is set to MNM_EMPTY_DATA_ITEM_LEN.
- Integer and double members are initialized to zero.
- Boolean members are set to false.
- Pointers (and pointers to arrays) are set to NULL.
```

--------------------------------

### startTimer

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1REngine.html

Starts a named timer.

```APIDOC
## int startTimer(tsNCharcb *const pTimerName, int *aiCode)

### Description
Starts a timer with the specified name.

### Parameters
- **pTimerName** (tsNCharcb* const) - Required - Name of the timer.
- **aiCode** (int*) - Required - Output parameter for error code.

### Returns
- **int** - Status code (0 for success, non-zero for error).
```

--------------------------------

### int REngine::listEnvironments(void* _pContext_, int* _aiCode_)

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1rengine

Retrieves a list of all available environment keys, including the default environment of "system" from REngineParams::envp. The list is returned via AdmCallbacks::EnvironmentList().

```APIDOC
## int REngine::listEnvironments(void* _pContext_, int* _aiCode_)

### Description
Retrieves a list of all available environment keys, including the default environment of "system" from REngineParams::envp. The list is returned via AdmCallbacks::EnvironmentList().

### Method
C++ method call

### Endpoint
REngine::listEnvironments

### Parameters
- **_pContext_** (void*) - Optional - Specifies a context pointer that will be returned with the callback conveying the results.
- **_aiCode_** (int*) - Required - Address of an integer to contain the return code of this routine.

### Callback
Results are delivered via AdmCallbacks::EnvironmentList() with an EnvironmentListInfo object.

### See Also
- AdmCallbacks::EnvironmentList()
- EnvironmentListInfo
- REngine::getEnvironment()
- REngine::setEnvironmentVariable()
- REngine::unsetEnvironmentVariable()
- Connecting to Multiple Rithmic Systems Simultaneously Using Environments
```

--------------------------------

### startTimer()

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1rengine

Starts the timer specified by pTimer.

```APIDOC
## startTimer()

### Description
Starts the timer specified by pTimer.

### Method
startTimer

### Signature
int REngine::startTimer(tsNCharcb* const _pTimer_, int* _aiCode_)

### Parameters
- **_pTimer_** (tsNCharcb* const) - Required - The timer to start.
- **_aiCode_** (int*) - Required - Out parameter to hold the error code, if applicable.

### Return Value
int - Returns OK on success, NOT_OK on error.

### See Also
- REngine::addTimer
- REngine::removeTimer
- REngine::stopTimer
```

--------------------------------

### RApi::REngine::startTimer

Source: https://jocular-pastelito-5c8054.netlify.app/rapiplus_8h_source

Starts a timer with the given name.

```APIDOC
## RApi::REngine::startTimer

### Description
Starts a timer with the given name.

### Method
C++ method

### Signature
`int startTimer(tsNCharcb *const pTimerName, int *aiCode)`

### Parameters
- **pTimerName** (tsNCharcb* const) - Required - Timer name.
- **aiCode** (int*) - Required - Pointer to store result code.

### Returns
- **int** - Status code (0 on success, non-zero on error).

```

--------------------------------

### RApi::REngine::listEnvironments

Source: https://jocular-pastelito-5c8054.netlify.app/rapiplus_8h_source

Lists available environments.

```APIDOC
## RApi::REngine::listEnvironments

### Description
Lists available environments.

### Method
int listEnvironments(void *pContext, int *aiCode)

### Parameters
- **pContext** (void*) - Required - User-defined context.
- **aiCode** (int*) - Required - Output parameter for error code.

### Returns
- **int** - Returns 0 on success, non-zero on failure.

```

--------------------------------

### RApi::REngine::getPendingInputSize

Source: https://jocular-pastelito-5c8054.netlify.app/rapiplus_8h_source

Gets the size of pending input.

```APIDOC
## RApi::REngine::getPendingInputSize

### Description
Gets the size of pending input.

### Method
int getPendingInputSize()

### Parameters
None.

### Returns
- **int** - The size of pending input.

```

--------------------------------

### Compile and link SampleMD.cpp on Linux with RApiPlus

Source: https://jocular-pastelito-5c8054.netlify.app/programmers_guide

Use this command to build SampleMD.cpp on 64-bit Linux (RHEL 7.x) with the RApiPlus package. It includes all necessary compiler flags and links against the required libraries. Ensure your working directory is the ./samples directory.

```bash
g++ -O3 -DLINUX -D_REENTRANT -Wall -Wno-sign-compare -Wno-write-strings -Wpointer-arith -Winline -Wno-deprecated -fno-strict-aliasing -I../include -o SampleMD ../samples/SampleMD.cpp -L../linux-gnu-3.10.0-x86_64/lib -lRApiPlus-optimize -lOmneStreamEngine-optimize -lOmneChannel-optimize -lOmneEngine-optimize -l_api-optimize -l_apipoll-stubs-optimize -l_kit-optimize -lssl -lcrypto -L/usr/lib64 -lz -lpthread -lrt -ldl
```

--------------------------------

### startTimer()

Source: https://jocular-pastelito-5c8054.netlify.app/functions_s.html

Starts the timer for the REngine. This method is used to begin timer-based operations.

```APIDOC
## startTimer()

### Description
Starts the timer for the REngine.

### Method
startTimer

### Signature
`startTimer()`

### Parameters
None

### Return Type
`void`

```

--------------------------------

### ProductRmsListInfo::ProductRmsListInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1productrmslistinfo

Constructor that initializes all members to default values. Sets tsNCharcb pData to MNM_EMPTY_DATA_ITEM, iDataLen to MNM_EMPTY_DATA_ITEM_LEN, integer and double members to zero, boolean members to false, and pointers to NULL.

```APIDOC
## ProductRmsListInfo::ProductRmsListInfo()

### Description
Constructor that initializes all members to default values. Sets tsNCharcb pData to MNM_EMPTY_DATA_ITEM, iDataLen to MNM_EMPTY_DATA_ITEM_LEN, integer and double members to zero, boolean members to false, and pointers to NULL.

### Method
Constructor

### Signature
`ProductRmsListInfo::ProductRmsListInfo()`

### Parameters
None

### Return Value
None
```

--------------------------------

### Class Members - m

Source: https://jocular-pastelito-5c8054.netlify.app/functions_m.html

Documentation for class members starting with the letter 'm' in the RApi namespace, including callbacks, constructors, and engine methods.

```APIDOC
## MarketMode()

### Description
Callback invoked when market mode information is received.

### Callback
`MarketMode()`

### Belongs to
`RApi::RCallbacks`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## MarketModeInfo()

### Description
Constructor for the MarketModeInfo class.

### Constructor
`MarketModeInfo()`

### Belongs to
`RApi::MarketModeInfo`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## MarketOrderParams()

### Description
Constructor for the MarketOrderParams class.

### Constructor
`MarketOrderParams()`

### Belongs to
`RApi::MarketOrderParams`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## MidPrice()

### Description
Callback invoked when mid-price information is received.

### Callback
`MidPrice()`

### Belongs to
`RApi::RCallbacks`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## MidPriceInfo()

### Description
Constructor for the MidPriceInfo class.

### Constructor
`MidPriceInfo()`

### Belongs to
`RApi::MidPriceInfo`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## modifyBracketTier()

### Description
Modifies a bracket tier.

### Method
`modifyBracketTier()`

### Belongs to
`RApi::REngine`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## ModifyLimitOrderParams()

### Description
Constructor for the ModifyLimitOrderParams class.

### Constructor
`ModifyLimitOrderParams()`

### Belongs to
`RApi::ModifyLimitOrderParams`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## modifyOrder()

### Description
Modifies an order.

### Method
`modifyOrder()`

### Belongs to
`RApi::REngine`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## modifyOrderList()

### Description
Modifies a list of orders.

### Method
`modifyOrderList()`

### Belongs to
`RApi::REngine`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## ModifyOrderParams()

### Description
Constructor for the ModifyOrderParams class.

### Constructor
`ModifyOrderParams()`

### Belongs to
`RApi::ModifyOrderParams`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## modifyOrderRefData()

### Description
Modifies order reference data.

### Method
`modifyOrderRefData()`

### Belongs to
`RApi::REngine`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## ModifyReport()

### Description
Callback invoked when a modify report is received.

### Callback
`ModifyReport()`

### Belongs to
`RApi::RCallbacks`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## ModifyStopLimitOrderParams()

### Description
Constructor for the ModifyStopLimitOrderParams class.

### Constructor
`ModifyStopLimitOrderParams()`

### Belongs to
`RApi::ModifyStopLimitOrderParams`

### Parameters
None documented.

### Returns
None documented.
```

```APIDOC
## ModifyStopMarketOrderParams()

### Description
Constructor for the ModifyStopMarketOrderParams class.

### Constructor
`ModifyStopMarketOrderParams()`

### Belongs to
`RApi::ModifyStopMarketOrderParams`

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### Compile/link SampleMD.cpp on darwin-10 (64-bit)

Source: https://jocular-pastelito-5c8054.netlify.app/programmers_guide

Use this g++ command to compile and link SampleMD.cpp on 64-bit darwin-10. It includes all required RApi and system libraries. Run from the ./samples directory.

```bash
g++ -O3 -D_REENTRANT -Wall -Wno-sign-compare -fno-strict-aliasing -Wpointer-arith -Winline -Wno-deprecated -Wno-write-strings -I../include -o ./SampleMD ../samples/SampleMD.cpp -L../darwin-10/lib -lRApiPlus-optimize -lOmneStreamEngine-optimize -lOmneChannel-optimize -lOmneEngine-optimize -l_api-optimize -l_apipoll-stubs-optimize -l_kit-optimize -lssl -lcrypto -L/usr/lib -lz -Wl,-search_paths_first
```

--------------------------------

### RApi Functions and Fields (b-prefix)

Source: https://jocular-pastelito-5c8054.netlify.app/functions_b.html

Lists RApi API functions and data fields starting with 'b' that users can call or access directly.

```APIDOC
## RApi Functions and Fields (b-prefix)

### Description
This section documents RApi API functions and data fields that begin with the letter 'b'. Functions are callable methods, and fields are data members of RApi data structures.

### Functions
- **Bar()** : RApi::RCallbacks - Callback for bar data.
- **BarInfo()** : RApi::BarInfo - Retrieves bar information.
- **BarParams()** : RApi::BarParams - Retrieves bar parameters.
- **BarReplay()** : RApi::RCallbacks - Callback for bar replay.
- **BarReplayInfo()** : RApi::BarReplayInfo - Retrieves bar replay information.
- **BestAskQuote()** : RApi::RCallbacks - Callback for best ask quote.
- **BestBidAskQuote()** : RApi::RCallbacks - Callback for best bid/ask quote.
- **BestBidQuote()** : RApi::RCallbacks - Callback for best bid quote.
- **BidInfo()** : RApi::BidInfo - Retrieves bid information.
- **BidQuote()** : RApi::RCallbacks - Callback for bid quote.
- **BinaryContractList()** : RApi::RCallbacks - Callback for binary contract list.
- **BinaryContractListInfo()** : RApi::BinaryContractListInfo - Retrieves binary contract list information.
- **BracketInfo()** : RApi::BracketInfo - Retrieves bracket information.
- **BracketParams()** : RApi::BracketParams - Retrieves bracket parameters.
- **BracketReplay()** : RApi::RCallbacks - Callback for bracket replay.
- **BracketReplayInfo()** : RApi::BracketReplayInfo - Retrieves bracket replay information.
- **BracketTier()** : RApi::BracketTier - Retrieves bracket tier.
- **BracketTierModify()** : RApi::RCallbacks - Callback for bracket tier modification.
- **BracketTierModifyInfo()** : RApi::BracketTierModifyInfo - Retrieves bracket tier modification information.
- **BracketUpdate()** : RApi::RCallbacks - Callback for bracket update.
- **BustReport()** : RApi::RCallbacks - Callback for bust report.

### Fields
- **bAccepted** : RApi::AgreementListInfo - Indicates acceptance status.
- **bAsk** : RApi::QuoteInfo, RApi::QuoteReport - Ask price field.
- **bAutoLiquidateAtSsm** : RApi::RmsInfo - Auto-liquidate at SSM flag.
- **bAutoLiquidateMaxMinAccountBalance** : RApi::RmsInfo - Auto-liquidate max/min account balance.
- **bAutoLiquidateThreshold** : RApi::RmsInfo - Auto-liquidate threshold.
- **bAvgFillPriceFlag** : RApi::LineInfo, RApi::OrderReport - Average fill price flag.
- **bBid** : RApi::QuoteInfo, RApi::QuoteParams, RApi::QuoteReport - Bid price field.
- **bBorrowable** : RApi::EasyToBorrowInfo - Borrowable flag.
- **bBuyerAsAggressorVolume** : RApi::BarInfo - Buyer as aggressor volume.
- **bBuyLimit** : RApi::ProductRmsInfo - Buy limit.
- **bBuyLongMarginRate** : RApi::ProductRmsInfo - Buy long margin rate.
- **bCancelAfter** : RApi::LineInfo, RApi::OrderParams - Cancel after time.
- **bCancelSsboe** : RApi::LineInfo, RApi::OrderParams - Cancel SSBOE flag.
- **bCancelUsecs** : RApi::LineInfo, RApi::OrderParams - Cancel time in microseconds.
- **bCapPrice** : RApi::RefDataInfo - Cap price.
- **bCaseSensitive** : RApi::SearchTerm - Case sensitive flag.
- **bCheckMinAccountBalance** : RApi::RmsInfo - Check minimum account balance flag.
- **bClosePrice** : RApi::CloseMidPriceInfo - Close price.
- **bCommissionFillRate** : RApi::ProductRmsInfo - Commission fill rate.
- **bCustomSession** : RApi::BarInfo, RApi::BarParams, RApi::BarReplayInfo - Custom session flag.
- **bDefaultCommission** : RApi::RmsInfo - Default commission.
- **bFill** : RApi::QuoteReport - Fill flag.
- **bFillPriceFlag** : RApi::OrderReport - Fill price flag.
- **bFloorPrice** : RApi::RefDataInfo - Floor price.
- **bHighPrice** : RApi::MidPriceInfo - High price.
- **bLastPrice** : RApi::MidPriceInfo - Last price.
- **bLeanPriceFlag** : RApi::AskInfo, RApi::BidInfo - Lean price flag.
- **bLossLimit** : RApi::ProductRmsInfo - Loss limit.
- **bLowPrice** : RApi::MidPriceInfo - Low price.
- **bMandatory** : RApi::AgreementInfo - Mandatory flag.
- **bMaxOrderQty** : RApi::ProductRmsInfo - Maximum order quantity.
- **bMaxPriceVariation** : RApi::RefDataInfo - Maximum price variation.
- **bMaxShowQty** : RApi::OrderParams - Maximum show quantity.
- **bMinMarginBalance** : RApi::RmsInfo - Minimum margin balance.
- **bMinQty** : RApi::ModifyOrderParams, RApi::OrderParams - Minimum quantity.
- **bMinSizeIncrement** : RApi::RefDataInfo - Minimum size increment.
- **bNetChange** : RApi::MidPriceInfo - Net change.
- **bNetChangeFlag** : RApi::TradeInfo - Net change flag.
- **bOpenPrice** : RApi::MidPriceInfo - Open price.
- **bPercentChange** : RApi::MidPriceInfo - Percent change.
- **bPercentChangeFlag** : RApi::TradeInfo - Percent change flag.
- **bPossOutOfOrder** : RApi::PnlInfo - Possible out of order flag.
- **bPreviousPrice** : RApi::DboInfo - Previous price.
- **bPrice** : RApi::DboBookRebuildInfo, RApi::DboInfo, RApi::ModifyOrderParams - Price field.
- **bPriceFlag** : RApi::AskInfo, RApi::BidInfo, RApi::ClosePriceInfo, RApi::ClosingIndicatorInfo, RApi::HighBidPriceInfo, RApi::HighPriceInfo, RApi::HighPriceLimitInfo, RApi::LowAskPriceInfo, RApi::LowPriceInfo, RApi::LowPriceLimitInfo, RApi::OpeningIndicatorInfo, RApi::OpenPriceInfo, RApi::ProjectedSettlementPriceInfo, RApi::SettlementPriceInfo, RApi::TradeInfo - Price flag.
- **bPriceToFillFlag** : RApi::LineInfo, RApi::OrderReport - Price to fill flag.
- **bProfile** : RApi::BarParams, RApi::BarReplayInfo - Profile flag.
- **bQty** : RApi::ModifyOrderParams - Quantity field.
- **bQuantityFlag** : RApi::OpenInterestInfo - Quantity flag.
- **bReleaseCondition** : RApi::OrderParams - Release condition.
- **bReleaseSsboe** : RApi::LineInfo, RApi::OrderParams - Release SSBOE flag.
- **bReleaseUsecs** : RApi::LineInfo, RApi::OrderParams - Release time in microseconds.
- **bReplacementOrderToFollow** : RApi::OrderRejectReport - Replacement order to follow.
- **bSellerAsAggressorVolume** : RApi::BarInfo - Seller as aggressor volume.
- **bSellLimit** : RApi::ProductRmsInfo - Sell limit.
- **bSellShortMarginRate** : RApi::ProductRmsInfo - Sell short margin rate.
- **bSettlementPrice** : RApi::BarInfo - Settlement price.
- **bSinglePointValue** : RApi::RefDataInfo - Single point value.
- **bSize** : RApi::DboInfo - Size field.
- **bSizeFlag** : RApi::AskInfo, RApi::BidInfo - Size flag.
- **bSizeMultiplier** : RApi::RefDataInfo - Size multiplier.
- **bStopsToMarketAt** : RApi::BracketInfo, RApi::BracketParams - Stops to market at.
- **bStrikePrice** : RApi::RefDataInfo - Strike price.
- **bTarget** : RApi::BracketTierModifyInfo - Target field.
- **bTargetsToMarketAfterPartialFillInSeconds** : RApi::BracketInfo, RApi::BracketParams - Targets to market after partial fill in seconds.
- **bTargetsToMarketAt** : RApi::BracketInfo, RApi::BracketParams - Targets to market at.
- **bToMarketAfterPartialFillInSeconds** : RApi::LineInfo, RApi::OrderParams - To market after partial fill in seconds.
- **bToMarketAt** : RApi::LineInfo, RApi::OrderParams - To market at.
- **bTotalVolumeFlag** : RApi::TradeVolumeInfo - Total volume flag.
- **bTrailByTicks** : RApi::ModifyOrderParams - Trail by ticks.
- **bTrailingStop** : RApi::BracketInfo, RApi::BracketParams, RApi::OrderParams - Trailing stop flag.
- **bTrailingStopTriggerTicks** : RApi::BracketInfo, RApi::BracketParams - Trailing stop trigger ticks.
- **bTriggerPrice** : RApi::ModifyOrderParams - Trigger price.
- **bTriggerPriceFlag** : RApi::LineInfo, RApi::OrderReport - Trigger price flag.
- **bUnitOfMeasureQty** : RApi::AuxRefDataInfo - Unit of measure quantity.
- **bVolumeBoughtFlag** : RApi::TradeInfo - Volume bought flag.
- **bVolumeFlag** : RApi::OpeningIndicatorInfo - Volume flag.
- **bVolumeSoldFlag** : RApi::TradeInfo - Volume sold flag.
- **bVwap** : RApi::BarInfo - VWAP value.
- **bVwapFlag** : RApi::TradeInfo - VWAP flag.
- **bVwapLong** : RApi::BarInfo - VWAP long value.
- **bVwapLongFlag** : RApi::TradeInfo - VWAP long flag.
```

--------------------------------

### Compile/link SampleMD.cpp on darwin-20.6-arm64

Source: https://jocular-pastelito-5c8054.netlify.app/programmers_guide

Use this g++ command to compile and link SampleMD.cpp on darwin-20.6-arm64. It includes all required RApi and system libraries. Run from the ./samples directory.

```bash
g++ -O3 -D_REENTRANT -Wall -Wno-sign-compare -fno-strict-aliasing -Wpointer-arith -Winline -Wno-deprecated -Wno-write-strings -I../include -o ./SampleMD ../samples/SampleMD.cpp -L../darwin-20.6-arm64/lib -lRApiPlus-optimize -lOmneStreamEngine-optimize -lOmneChannel-optimize -lOmneEngine-optimize -l_api-optimize -l_apipoll-stubs-optimize -l_kit-optimize -lssl -lcrypto -L/usr/lib -lz
```

--------------------------------

### ProductRmsInfo::clearHandles

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1ProductRmsInfo.html

Initializes all members of the ProductRmsInfo object, setting character data to empty items and integer members to zero.

```APIDOC
## ProductRmsInfo::clearHandles

### Description
This routine initializes all of the members. The pData of each tsNCharcb is set to MNM_EMPTY_DATA_ITEM and the iDataLen of each tsNCharcb is set to MNM_EMPTY_DATA_ITEM_LEN. The lSize member variable is initialized to zero.

### Method
clearHandles

### Parameters
- **aiCode** (int*) - Pointer to an integer code.

### Returns
- **int** - Status code indicating success or failure.
```

--------------------------------

### RApi::SodReport

Source: https://jocular-pastelito-5c8054.netlify.app/rapiplus_8h_source

Represents a position and close price of an instrument when the trading day starts. Contains fields for ticker, previous close price, report type, and account.

```APIDOC
## RApi::SodReport

### Description
Represents a position and close price of an instrument when the trading day starts. Contains fields for ticker, previous close price, report type, and account.

### Fields
- **dPrevClosePrice** (double) - Previous close price.
- **sReportType** (tsNCharcb) - Report type.
- **sTicker** (tsNCharcb) - Ticker symbol.
- **oAccount** (AccountInfo) - Account information.

### Methods
- **SodReport()** - Constructor.

```

--------------------------------

### QuoteInfo::dump()

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1quoteinfo

Prints the current values of the QuoteInfo object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## QuoteInfo::dump()

### Description
Prints the current values of the QuoteInfo object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

### Method
`int QuoteInfo::dump(int* _aiCode_)`

### Parameters
- `_aiCode_` (int*) - Pointer to an integer code (purpose not specified in source).

### Returns
- `int` - Return code (not specified in source).

```

--------------------------------

### REngine Constructor

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1REngine.html

Initializes a new REngine instance with the specified parameters.

```APIDOC
## REngine(REngineParams *pParams)

### Description
Constructs an REngine object with the given parameters.

### Parameters
- **pParams** (REngineParams*) - Required - Pointer to the engine parameters.

### Returns
- No return value (constructor).
```

--------------------------------

### BinaryContractListInfo::BinaryContractListInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1binarycontractlistinfo

Constructor that initializes all members to default values.

```APIDOC
## BinaryContractListInfo::BinaryContractListInfo()

### Description
This constructor initializes all of the members. The pData of each tsNCharcb is set to NULL and the iDataLen of each tsNCharcb is set to zero. Integer members and double members are initialized to zero. Boolean members are set to false. Pointers (and pointers to arrays) are set to NULL.

### Method
Constructor

### Signature
`BinaryContractListInfo::BinaryContractListInfo()`

### Parameters
None

### Return Value
None (constructor)
```

--------------------------------

### QuoteReport::dump(int*)

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1quotereport

Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## dump(int*)

### Description
This routine will print the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value. For example, doubles may only be printed to six decimal places, even if the value of the double has a greater significant precision.

### Method
Member function

### Signature
`virtual int dump(int* _aiCode_)`

### Parameters
- `_aiCode_` (int*) - Pointer to an integer code.

```

--------------------------------

### RApi::LoginParams::sTsCnnctPt

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1loginparams

Optional. Name of the order plant/trading system connection. Specify this value to connect to the trading system for order services such as placing, modifying and cancelling orders, and getting order updates.

```APIDOC
## sTsCnnctPt

### Description
Optional. Name of the order plant/trading system connection. Specify this value to connect to the trading system for order services such as placing, modifying and cancelling orders, and getting order updates.

### Type
string (optional)
```

--------------------------------

### LowAskPriceInfo::LowAskPriceInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1LowAskPriceInfo.html

Constructor that initializes all members to default values.

```APIDOC
## LowAskPriceInfo::LowAskPriceInfo()

### Description
Initializes all members. Sets pData of each tsNCharcb to NULL, iDataLen to zero, integer and double members to zero, and boolean members to false.

### Method
Constructor

### Parameters
None

### Returns
No return value (constructor).

### Example
```cpp
LowAskPriceInfo info;
```
```

--------------------------------

### RApi::VALUE_STATE_USE

Source: https://jocular-pastelito-5c8054.netlify.app/namespacerapi

Constant indicating that the corresponding value should be used. For example, when a position is taken, the average open fill price becomes a well-defined value and an update via PnlInfo would reflect that change.

```APIDOC
## RApi::VALUE_STATE_USE

### Description
Indicates that the corresponding value should be used. An example would be if a position is taken on some instrument, the average open fill price (which previously did not apply) would become a well defined value. An update via PnlInfo would reflect that change, with PnlInfo::eAvgOpenFillPrice set with a value of INSTRUCTION_USE, indicating that the value in PnlInfo::dAvgOpenFillPrice be used.

### Constant Value
`const int RApi::VALUE_STATE_USE = 2`

### See Also
- RApi::VALUE_STATE_IGNORE
- RApi::VALUE_STATE_CLEAR
- RApi::VALUE_STATE_USE
- RCallbacks::PnlUpdate
- PnlInfo::eAvgOpenFillPrice
- PnlInfo::dAvgOpenFillPrice
```

--------------------------------

### Constructor: IbListInfo::IbListInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1iblistinfo

Constructs an IbListInfo object, initializing all members to their default values.

```APIDOC
## Constructor `IbListInfo::IbListInfo`

### Description
This constructor initializes all of the members. The `pData` of each `tsNCharcb` is set to `NULL` and the `iDataLen` of each `tsNCharcb` is set to zero. Integer members and double members are initialized to zero. Boolean members are set to `false`. Pointers (and pointers to arrays) are set to `NULL`.

### Syntax
`IbListInfo::IbListInfo()`

```

--------------------------------

### HighPriceLimitInfo::HighPriceLimitInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1HighPriceLimitInfo.html

Constructor that initializes all members to default values.

```APIDOC
## HighPriceLimitInfo::HighPriceLimitInfo()

### Description
This constructor initializes all of the members. The pData of each tsNCharcb is set to NULL and the iDataLen of each tsNCharcb is set to zero. Integer members and double members are initialized to zero. Boolean members are set to false.

### Method
Constructor

### Signature
`HighPriceLimitInfo::HighPriceLimitInfo()`

### Parameters
None

### Returns
None
```

--------------------------------

### SingleOrderReplayInfo::dump(int *aiCode)

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1singleorderreplayinfo

Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## dump(int *aiCode)

### Description
Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

### Method
Member function

### Signature
`int SingleOrderReplayInfo::dump(int *aiCode)`

### Parameters
- **aiCode** (int*) - Required - Pointer to an integer that receives a return code.

### Returns
- **int** - Return code indicating success or failure of the dump operation.
```

--------------------------------

### EnvironmentListInfo::EnvironmentListInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1EnvironmentListInfo.html

Constructor that initializes all members to default values.

```APIDOC
## EnvironmentListInfo::EnvironmentListInfo()

### Description
This constructor initializes all of the members. The pData of each tsNCharcb is set to NULL and the iDataLen of each tsNCharcb is set to zero. Integer members and double members are initialized to zero. Boolean members are set to false. Pointers (and pointers to arrays) are set to NULL.

### Method
Constructor

### Signature
EnvironmentListInfo::EnvironmentListInfo()
```

--------------------------------

### QuoteReplayInfo::dump(int *aiCode)

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1QuoteReplayInfo.html

Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## QuoteReplayInfo::dump(int *aiCode)

### Description
This routine will print the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value. For example, doubles may only be printed to six decimal places, even if the value of the double has a greater significant precision.

### Method
Member function

### Signature
`int QuoteReplayInfo::dump(int *aiCode)`

### Parameters
- **aiCode** (int*) - Pointer to an integer code. The exact purpose is not documented in the source.

### Returns
- **int** - Return value not documented in the source.
```

--------------------------------

### LineInfo::dump(int* _aiCode_)

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1LineInfo.html

Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## LineInfo::dump(int* _aiCode_)

### Description
This routine will print the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value. For example, doubles may only be printed to six decimal places, even if the value of the double has a greater significant precision.

### Method
dump

### Parameters
- **_aiCode_** (int*) - Description not provided in source.

### Returns
- int - Return value not specified in source.

```

--------------------------------

### int REngine::getOptionList(tsNCharcb* _pExchange_, tsNCharcb* _pProductCode_, tsNCharcb* _pExpirationCCYYMM_, void* _pContext_, int* _aiCode_)

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1rengine

Requests a list of options. The method supports a drill-down approach: passing no exchange returns a list of exchanges, passing an exchange returns product codes, passing exchange and product code returns expiration dates, and passing all three returns RefDataInfos.

```APIDOC
## int REngine::getOptionList(tsNCharcb* _pExchange_, tsNCharcb* _pProductCode_, tsNCharcb* _pExpirationCCYYMM_, void* _pContext_, int* _aiCode_)

### Description
Requests a list of options. The method supports a drill-down approach: passing no exchange returns a list of exchanges, passing an exchange returns product codes, passing exchange and product code returns expiration dates, and passing all three returns RefDataInfos.

### Method
C++ method

### Signature
int REngine::getOptionList(tsNCharcb* _pExchange_, tsNCharcb* _pProductCode_, tsNCharcb* _pExpirationCCYYMM_, void* _pContext_, int* _aiCode_)

### Parameters
- **_pExchange_** (tsNCharcb*) - Optional - Exchange identifier. If not provided, the callback returns a list of exchanges.
- **_pProductCode_** (tsNCharcb*) - Optional - Product code within the exchange. If provided with exchange, returns product codes.
- **_pExpirationCCYYMM_** (tsNCharcb*) - Optional - Expiration date in CCYYMM format. If provided with exchange and product code, returns expiration dates.
- **_pContext_** (void*) - Optional - Context pointer passed to the callback.
- **_aiCode_** (int*) - Output - Pointer to an integer that receives a result code.

### Callback Information
The callback receives an OptionListInfo structure containing arrays based on the input parameters:
- If no exchange passed: OptionListInfo::pExchangeArray
- If exchange passed: OptionListInfo::pProductCodeArray
- If exchange and product code passed: OptionListInfo::pExpirationCCYYMMArray
- If exchange, product code, and expiration passed: OptionListInfo::asRefDataInfoArray

### Return Value
Returns an integer indicating success or failure.

```

--------------------------------

### ExecutionReplayInfo::dump(int *aiCode)

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1ExecutionReplayInfo.html

Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## ExecutionReplayInfo::dump(int *aiCode)

### Description
Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

### Method
Member Function

### Signature
int ExecutionReplayInfo::dump(int *aiCode)

### Parameters
- **aiCode** (int*) - Description: Pointer to an integer code. The exact purpose is not specified in the source.

### Return Value
int - The return value is not specified in the source.
```

--------------------------------

### LowPriceLimitInfo::LowPriceLimitInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1LowPriceLimitInfo.html

Constructor that initializes all members to default values: tsNCharcb pData set to NULL, iDataLen set to zero, integer and double members set to zero, boolean members set to false.

```APIDOC
## LowPriceLimitInfo::LowPriceLimitInfo()

### Description
This constructor initializes all of the members. The pData of each tsNCharcb is set to NULL and the iDataLen of each tsNCharcb is set to zero. Integer members and double members are initialized to zero. Boolean members are set to false.

### Method
Constructor

### Signature
`LowPriceLimitInfo::LowPriceLimitInfo()`

### Parameters
None

### Returns
None
```

--------------------------------

### BracketReplayInfo::dump(int *aiCode)

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1BracketReplayInfo.html

Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## BracketReplayInfo::dump(int *aiCode)

### Description
Prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

### Method
`dump`

### Parameters
- `aiCode` (int*) - Pointer to an integer code. The exact purpose is not specified in the source.

### Returns
- `int` - The return value is not specified in the source.

```

--------------------------------

### ProductRmsInfo::clearHandles(int *aiCode)

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1productrmsinfo

Initializes all members to default values, similar to the constructor.

```APIDOC
## ProductRmsInfo::clearHandles(int *aiCode)

### Description
This routine initializes all of the members. The pData of each tsNCharcb is set to MNM_EMPTY_DATA_ITEM and the iDataLen of each tsNCharcb is set to MNM_EMPTY_DATA_ITEM_LEN. The lSize member variable is initialized to zero.

### Method
clearHandles

### Signature
`int ProductRmsInfo::clearHandles(int *aiCode)`

### Parameters
- **aiCode** (int*) - Description not provided in source.

### Returns
- **int** - Return code (description not provided in source).
```

--------------------------------

### AskInfo::AskInfo()

Source: https://jocular-pastelito-5c8054.netlify.app/classrapi_1_1askinfo

Constructor that initializes all members. Sets pData of each tsNCharcb to NULL, iDataLen to zero, integer and double members to zero, and boolean members to false.

```APIDOC
## AskInfo::AskInfo()

### Description
This constructor initializes all of the members. The pData of each tsNCharcb is set to NULL and the iDataLen of each tsNCharcb is set to zero. Integer members and double members are initialized to zero. Boolean members are set to false.

### Method
Constructor

### Signature
`AskInfo::AskInfo()`

### Parameters
None

### Return Value
None
```

--------------------------------

### OrderReplayInfo::dump(int *aiCode)

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1OrderReplayInfo.html

Prints the current values of the object to stdout. Note that the precision of the output may not reflect the actual precision of the value; for example, doubles may be printed to six decimal places.

```APIDOC
## OrderReplayInfo::dump(int *aiCode)

### Description
Prints the current values of the object to stdout. Note that the precision of the output may not reflect the actual precision of the value; for example, doubles may be printed to six decimal places.

### Method
Member function

### Signature
`int OrderReplayInfo::dump(int *aiCode)`

### Parameters
- **aiCode** (int*) - Required - Pointer to an integer code (purpose not specified in source).

### Returns
- **int** - Return code (exact meaning not specified in source).
```

--------------------------------

### OrderReport::dump(int* _aiCode_)

Source: https://jocular-pastelito-5c8054.netlify.app/classRApi_1_1OrderReport.html

Virtual routine that prints the current values of the object to stdout. The precision of the output may not reflect the actual precision of the value; for example, doubles may only be printed to six decimal places.

```APIDOC
## OrderReport::dump(int* _aiCode_)

### Description
Virtual routine that prints the current values of the object to stdout.

### Method
dump

### Signature
`virtual int OrderReport::dump(int* _aiCode_)`

### Parameters
- **_aiCode_** (int*) - Pointer to an integer code (purpose not specified in source)

### Returns
- **int** - Status code (exact meaning not specified in source)

### Remarks
- The precision of the output may not reflect the actual precision of the value. For example, doubles may only be printed to six decimal places.
- Reimplemented in RApi::OrderBustReport, RApi::OrderCancelReport, RApi::OrderFailureReport, RApi::OrderFillReport, RApi::OrderModifyReport, RApi::OrderNotCancelledReport, RApi::OrderNotModifiedReport, RApi::OrderRejectReport, RApi::OrderStatusReport, RApi::OrderTradeCorrectReport, RApi::OrderTriggerPulledReport, and RApi::OrderTriggerReport
```
Tokens:
Raw