# Protocol Documentation
<a name="top"></a>

## Table of Contents

- [job_schemas.proto](#job_schemas.proto)
    - [OracleJob](#.OracleJob)
    - [OracleJob.AddTask](#.OracleJob.AddTask)
    - [OracleJob.AnchorFetchTask](#.OracleJob.AnchorFetchTask)
    - [OracleJob.BufferLayoutParseTask](#.OracleJob.BufferLayoutParseTask)
    - [OracleJob.CacheTask](#.OracleJob.CacheTask)
    - [OracleJob.CacheTask.CacheItem](#.OracleJob.CacheTask.CacheItem)
    - [OracleJob.ConditionalTask](#.OracleJob.ConditionalTask)
    - [OracleJob.DefiKingdomsTask](#.OracleJob.DefiKingdomsTask)
    - [OracleJob.DefiKingdomsTask.Token](#.OracleJob.DefiKingdomsTask.Token)
    - [OracleJob.DivideTask](#.OracleJob.DivideTask)
    - [OracleJob.HttpTask](#.OracleJob.HttpTask)
    - [OracleJob.HttpTask.Header](#.OracleJob.HttpTask.Header)
    - [OracleJob.JsonParseTask](#.OracleJob.JsonParseTask)
    - [OracleJob.JupiterSwapTask](#.OracleJob.JupiterSwapTask)
    - [OracleJob.LendingRateTask](#.OracleJob.LendingRateTask)
    - [OracleJob.LpExchangeRateTask](#.OracleJob.LpExchangeRateTask)
    - [OracleJob.LpTokenPriceTask](#.OracleJob.LpTokenPriceTask)
    - [OracleJob.MangoPerpMarketTask](#.OracleJob.MangoPerpMarketTask)
    - [OracleJob.MarinadeStateTask](#.OracleJob.MarinadeStateTask)
    - [OracleJob.MaxTask](#.OracleJob.MaxTask)
    - [OracleJob.MeanTask](#.OracleJob.MeanTask)
    - [OracleJob.MedianTask](#.OracleJob.MedianTask)
    - [OracleJob.MultiplyTask](#.OracleJob.MultiplyTask)
    - [OracleJob.OracleTask](#.OracleJob.OracleTask)
    - [OracleJob.PancakeswapExchangeRateTask](#.OracleJob.PancakeswapExchangeRateTask)
    - [OracleJob.PerpMarketTask](#.OracleJob.PerpMarketTask)
    - [OracleJob.PowTask](#.OracleJob.PowTask)
    - [OracleJob.RegexExtractTask](#.OracleJob.RegexExtractTask)
    - [OracleJob.SerumSwapTask](#.OracleJob.SerumSwapTask)
    - [OracleJob.SolanaAccountDataFetchTask](#.OracleJob.SolanaAccountDataFetchTask)
    - [OracleJob.SplStakePoolTask](#.OracleJob.SplStakePoolTask)
    - [OracleJob.SplTokenParseTask](#.OracleJob.SplTokenParseTask)
    - [OracleJob.SubtractTask](#.OracleJob.SubtractTask)
    - [OracleJob.SushiswapExchangeRateTask](#.OracleJob.SushiswapExchangeRateTask)
    - [OracleJob.SysclockOffsetTask](#.OracleJob.SysclockOffsetTask)
    - [OracleJob.Task](#.OracleJob.Task)
    - [OracleJob.TpsTask](#.OracleJob.TpsTask)
    - [OracleJob.TwapTask](#.OracleJob.TwapTask)
    - [OracleJob.UniswapExchangeRateTask](#.OracleJob.UniswapExchangeRateTask)
    - [OracleJob.ValueTask](#.OracleJob.ValueTask)
    - [OracleJob.WebsocketTask](#.OracleJob.WebsocketTask)
    - [OracleJob.XStepPriceTask](#.OracleJob.XStepPriceTask)
  
    - [OracleJob.BufferLayoutParseTask.BufferParseType](#.OracleJob.BufferLayoutParseTask.BufferParseType)
    - [OracleJob.BufferLayoutParseTask.Endian](#.OracleJob.BufferLayoutParseTask.Endian)
    - [OracleJob.HttpTask.Method](#.OracleJob.HttpTask.Method)
    - [OracleJob.JsonParseTask.AggregationMethod](#.OracleJob.JsonParseTask.AggregationMethod)
    - [OracleJob.LendingRateTask.Field](#.OracleJob.LendingRateTask.Field)
  
- [Scalar Value Types](#scalar-value-types)



<a name="job_schemas.proto"></a>
<p align="right"><a href="#top">Top</a></p>

## job_schemas.proto



<a name=".OracleJob"></a>

### OracleJob
Represnts a list of tasks to be performed by a switchboard oracle.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| tasks | [OracleJob.Task](#OracleJob.Task) | repeated | The chain of tasks to perform for this OracleJob. |






<a name=".OracleJob.AddTask"></a>

### OracleJob.AddTask
This task will add a numerical input by a scalar value or by another
aggregate.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| scalar | [double](#double) | optional | Specifies a scalar to add by. |
| aggregator_pubkey | [string](#string) | optional | Specifies an aggregator to add by. |
| job | [OracleJob](#OracleJob) | optional | A job whose result is computed before adding our numerical input by that result. |
| big | [string](#string) | optional | A stringified big.js. `Accepts variable expansion syntax.` |






<a name=".OracleJob.AnchorFetchTask"></a>

### OracleJob.AnchorFetchTask
Load a parse an Anchor based solana account.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| program_id | [string](#string) | optional | Owning program of the account to parse. |
| account_address | [string](#string) | optional | The account to parse. |






<a name=".OracleJob.BufferLayoutParseTask"></a>

### OracleJob.BufferLayoutParseTask
Return the deserialized value from a stringified buffer.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| offset | [uint32](#uint32) | optional | The buffer offset to start deserializing from. |
| endian | [OracleJob.BufferLayoutParseTask.Endian](#OracleJob.BufferLayoutParseTask.Endian) | optional | The endianness of the stored value. |
| type | [OracleJob.BufferLayoutParseTask.BufferParseType](#OracleJob.BufferLayoutParseTask.BufferParseType) | optional | The type of value to deserialize. |






<a name=".OracleJob.CacheTask"></a>

### OracleJob.CacheTask
Execute a job and store the result in a variable to reference later.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| cache_items | [OracleJob.CacheTask.CacheItem](#OracleJob.CacheTask.CacheItem) | repeated | A list of cached variables to reference in the job with `${VARIABLE_NAME}`. |






<a name=".OracleJob.CacheTask.CacheItem"></a>

### OracleJob.CacheTask.CacheItem



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| variable_name | [string](#string) | optional | The name of the variable to store in cache to reference later with `${VARIABLE_NAME}`. |
| job | [OracleJob](#OracleJob) | optional | The OracleJob to execute to yield the value to store in cache. |






<a name=".OracleJob.ConditionalTask"></a>

### OracleJob.ConditionalTask
This task will run the `attempt` subtasks in an effort to produce a valid numerical result. If
`attempt` fails to produce an acceptable result, `on_failure` subtasks will be run instead.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| attempt | [OracleJob.Task](#OracleJob.Task) | repeated | A list of subtasks to process in an attempt to produce a valid numerical result. |
| on_failure | [OracleJob.Task](#OracleJob.Task) | repeated | A list of subtasks that will be run if `attempt` subtasks are unable to produce an acceptable result. |






<a name=".OracleJob.DefiKingdomsTask"></a>

### OracleJob.DefiKingdomsTask
Fetch the swap price from DefiKingdoms.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| provider | [string](#string) | optional | The RPC provider to use for the swap. |
| in_token | [OracleJob.DefiKingdomsTask.Token](#OracleJob.DefiKingdomsTask.Token) | optional | The input token of the swap. |
| out_token | [OracleJob.DefiKingdomsTask.Token](#OracleJob.DefiKingdomsTask.Token) | optional | The output token of the swap. |






<a name=".OracleJob.DefiKingdomsTask.Token"></a>

### OracleJob.DefiKingdomsTask.Token



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [string](#string) | optional | The address of the token. |
| decimals | [int32](#int32) | optional | The number of decimal places for a token. |






<a name=".OracleJob.DivideTask"></a>

### OracleJob.DivideTask
This task will divide a numerical input by a scalar value or by another
aggregate.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| scalar | [double](#double) | optional | Specifies a basic scalar denominator to divide by. |
| aggregator_pubkey | [string](#string) | optional | Specifies another aggregator resut to divide by. |
| job | [OracleJob](#OracleJob) | optional | A job whose result is computed before dividing our numerical input by that result. |
| big | [string](#string) | optional | A stringified big.js. `Accepts variable expansion syntax.` |






<a name=".OracleJob.HttpTask"></a>

### OracleJob.HttpTask
The adapter will report the text body of a successful HTTP request to the specified url, 
or return an error if the response status code is greater than or equal to 400.
@return string representation of it&#39;s output.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| url | [string](#string) | optional | A string containing the URL to direct this HTTP request to. |
| method | [OracleJob.HttpTask.Method](#OracleJob.HttpTask.Method) | optional | The type of HTTP request to make. |
| headers | [OracleJob.HttpTask.Header](#OracleJob.HttpTask.Header) | repeated | A list of headers to add to this HttpTask. |
| body | [string](#string) | optional | A stringified body (if any) to add to this HttpTask. |






<a name=".OracleJob.HttpTask.Header"></a>

### OracleJob.HttpTask.Header
An object that represents a header to add to an HTTP request.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [string](#string) | optional |  |
| value | [string](#string) | optional |  |






<a name=".OracleJob.JsonParseTask"></a>

### OracleJob.JsonParseTask
The adapter walks the path specified and returns the value found at that result. If returning
JSON data from the HttpGet or HttpPost adapters, you must use this adapter to parse the 
response.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [string](#string) | optional | JSONPath formatted path to the element. https://t.ly/uLtw https://www.npmjs.com/package/jsonpath-plus |
| aggregation_method | [OracleJob.JsonParseTask.AggregationMethod](#OracleJob.JsonParseTask.AggregationMethod) | optional | The technique that will be used to aggregate the results if walking the specified path returns multiple numerical results. |






<a name=".OracleJob.JupiterSwapTask"></a>

### OracleJob.JupiterSwapTask
Fetch the simulated price for a swap on JupiterSwap.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| in_token_address | [string](#string) | optional | The input token address. |
| out_token_address | [string](#string) | optional | The output token address. |
| base_amount | [double](#double) | optional | The amount of tokens to swap. |






<a name=".OracleJob.LendingRateTask"></a>

### OracleJob.LendingRateTask
Fetch the lending rates for various Solana protocols


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| protocol | [string](#string) | optional | 01, apricot, francium, jet, larix, mango, port, solend, tulip |
| asset_mint | [string](#string) | optional | A token mint address supported by the chosen protocol |
| field | [OracleJob.LendingRateTask.Field](#OracleJob.LendingRateTask.Field) | optional |  |






<a name=".OracleJob.LpExchangeRateTask"></a>

### OracleJob.LpExchangeRateTask
Fetch the current swap price for a given liquidity pool


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| in_token_address | [string](#string) | optional | Used alongside mercurial_pool_address to specify the input token for a swap. |
| out_token_address | [string](#string) | optional | Used alongside mercurial_pool_address to specify the output token for a swap. |
| mercurial_pool_address | [string](#string) | optional | Mercurial finance pool address. A full list can be found here: https://github.com/mercurial-finance/stable-swap-n-pool-js |
| saber_pool_address | [string](#string) | optional | Saber pool address. A full list can be found here: https://github.com/saber-hq/saber-registry-dist |
| orca_pool_token_mint_address | [string](#string) | optional | **Deprecated.** Orca pool address. |
| raydium_pool_address | [string](#string) | optional | The Raydium liquidity pool ammId. A full list can be found here: https://sdk.raydium.io/liquidity/mainnet.json |
| orca_pool_address | [string](#string) | optional | Pool address for an Orca LP pool or whirlpool. A full list of Orca LP pools can be found here: https://www.orca.so/pools |






<a name=".OracleJob.LpTokenPriceTask"></a>

### OracleJob.LpTokenPriceTask
Fetch LP token price info from a number of supported exchanges.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| mercurial_pool_address | [string](#string) | optional | Mercurial finance pool address. A full list can be found here: https://github.com/mercurial-finance/stable-swap-n-pool-js |
| saber_pool_address | [string](#string) | optional | Saber pool address. A full list can be found here: https://github.com/saber-hq/saber-registry-dist |
| orca_pool_address | [string](#string) | optional | Orca pool address. A full list can be found here: https://www.orca.so/pools |
| raydium_pool_address | [string](#string) | optional | The Raydium liquidity pool ammId. A full list can be found here: https://sdk.raydium.io/liquidity/mainnet.json |
| price_feed_addresses | [string](#string) | repeated | A list of Switchboard aggregator accounts used to calculate the fair LP price. This ensures the price is based on the previous round to mitigate flash loan price manipulation. |
| price_feed_jobs | [OracleJob](#OracleJob) | repeated |  |
| use_fair_price | [bool](#bool) | optional | If enabled and price_feed_addresses provided, the oracle will calculate the fair LP price based on the liquidity pool reserves. See our blog post for more information: https://switchboardxyz.medium.com/fair-lp-token-oracles-94a457c50239 |






<a name=".OracleJob.MangoPerpMarketTask"></a>

### OracleJob.MangoPerpMarketTask
Fetch the current price for a Mango perpetual market


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| perp_market_address | [string](#string) | optional | Mainnet address for a mango perpetual market. A full list can be found here: https://github.com/blockworks-foundation/mango-client-v3/blob/main/src/ids.json |






<a name=".OracleJob.MarinadeStateTask"></a>

### OracleJob.MarinadeStateTask







<a name=".OracleJob.MaxTask"></a>

### OracleJob.MaxTask
Returns the maximum value of all the results returned by the provided subtasks and subjobs.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| tasks | [OracleJob.Task](#OracleJob.Task) | repeated | A list of subtasks to process and produce a list of result values. |
| jobs | [OracleJob](#OracleJob) | repeated | A list of subjobs to process and produce a list of result values. |






<a name=".OracleJob.MeanTask"></a>

### OracleJob.MeanTask
Returns the mean of all the results returned by the provided subtasks and subjobs.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| tasks | [OracleJob.Task](#OracleJob.Task) | repeated | A list of subtasks to process and produce a list of result values. |
| jobs | [OracleJob](#OracleJob) | repeated | A list of subjobs to process and produce a list of result values. |






<a name=".OracleJob.MedianTask"></a>

### OracleJob.MedianTask
Returns the median of all the results returned by the provided subtasks and subjobs. Nested tasks must return a Number.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| tasks | [OracleJob.Task](#OracleJob.Task) | repeated | A list of subtasks to process and produce a list of result values. |
| jobs | [OracleJob](#OracleJob) | repeated | A list of subjobs to process and produce a list of result values. |
| min_successful_required | [int32](#int32) | optional |  |






<a name=".OracleJob.MultiplyTask"></a>

### OracleJob.MultiplyTask
This task will multiply a numerical input by a scalar value or by another aggregator.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| scalar | [double](#double) | optional | Specifies a scalar to multiply by. |
| aggregator_pubkey | [string](#string) | optional | Specifies an aggregator to multiply by. |
| job | [OracleJob](#OracleJob) | optional | A job whose result is computed before multiplying our numerical input by that result. |
| big | [string](#string) | optional | A stringified big.js. `Accepts variable expansion syntax.` |






<a name=".OracleJob.OracleTask"></a>

### OracleJob.OracleTask
Fetch the current price of a Solana oracle protocol.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| switchboard_address | [string](#string) | optional | Mainnet address of a Switchboard V2 feed. Switchboard is decentralized and allows anyone to build their own feed. A small subset of feeds is available here: https://switchboard.xyz/explorer |
| pyth_address | [string](#string) | optional | Mainnet address for a Pyth feed. A full list can be found here: https://pyth.network/price-feeds/ |
| chainlink_address | [string](#string) | optional | Mainnet address for a Chainlink feed. A full list can be found here: https://docs.chain.link/docs/solana/data-feeds-solana |
| pyth_allowed_confidence_interval | [double](#double) | optional | Value (as a percentage) that the lower bound confidence interval is of the actual value. Confidence intervals that are larger that this treshold are rejected. |






<a name=".OracleJob.PancakeswapExchangeRateTask"></a>

### OracleJob.PancakeswapExchangeRateTask
Fetch the swap price from PancakeSwap.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| in_token_address | [string](#string) | optional | The input token address. |
| out_token_address | [string](#string) | optional | The output token address. |
| in_token_amount | [double](#double) | optional | The amount of tokens to swap. |
| slippage | [double](#double) | optional | The allowable slippage in percent for the swap. |
| provider | [string](#string) | optional | The RPC provider to use for the swap. |






<a name=".OracleJob.PerpMarketTask"></a>

### OracleJob.PerpMarketTask
Fetch the current price of a perpetual market.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| mango_market_address | [string](#string) | optional | Market address for a mango perpetual market. A full list can be found here: https://github.com/blockworks-foundation/mango-client-v3/blob/main/src/ids.json |
| drift_market_address | [string](#string) | optional | Market address for a drift perpetual market. A full list can be found here: https://github.com/drift-labs/protocol-v1/blob/master/sdk/src/constants/markets.ts |
| zeta_market_address | [string](#string) | optional | Market address for a zeta perpetual market. |
| zo_market_address | [string](#string) | optional | Market address for a 01 protocol perpetual market. |






<a name=".OracleJob.PowTask"></a>

### OracleJob.PowTask
Take the power of the working value.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| scalar | [double](#double) | optional | Take the working value to the exponent of value. |
| aggregator_pubkey | [string](#string) | optional | Take the working value to the exponent of the aggregators value. |
| big | [string](#string) | optional | A stringified big.js. `Accepts variable expansion syntax.` |






<a name=".OracleJob.RegexExtractTask"></a>

### OracleJob.RegexExtractTask
Find a pattern within a string of a previous task and extract a group number.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| pattern | [string](#string) | optional | Regex pattern to find. |
| group_number | [int32](#int32) | optional | Group number to extract. |






<a name=".OracleJob.SerumSwapTask"></a>

### OracleJob.SerumSwapTask
Fetch the latest swap price on Serum&#39;s orderbook


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| serum_pool_address | [string](#string) | optional | The serum pool to fetch swap price for |






<a name=".OracleJob.SolanaAccountDataFetchTask"></a>

### OracleJob.SolanaAccountDataFetchTask
Fetch the account data in a stringified buffer format.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| pubkey | [string](#string) | optional | The on-chain account to fetch the account data from. |






<a name=".OracleJob.SplStakePoolTask"></a>

### OracleJob.SplStakePoolTask
Fetch the JSON representation of an SPL Stake Pool account.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| pubkey | [string](#string) | optional | The pubkey of the SPL Stake Pool. |






<a name=".OracleJob.SplTokenParseTask"></a>

### OracleJob.SplTokenParseTask
Fetch the JSON representation of an SPL token mint.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| token_account_address | [string](#string) | optional | The publicKey of a token account to fetch the mintInfo for. |
| mint_address | [string](#string) | optional | The publicKey of the token mint address. |






<a name=".OracleJob.SubtractTask"></a>

### OracleJob.SubtractTask
This task will subtract a numerical input by a scalar value or by another
aggregate.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| scalar | [double](#double) | optional | Specifies a scalar to subtract by. |
| aggregator_pubkey | [string](#string) | optional | Specifies an aggregator to subtract by. |
| job | [OracleJob](#OracleJob) | optional | A job whose result is computed before subtracting our numerical input by that result. |
| big | [string](#string) | optional | A stringified big.js. `Accepts variable expansion syntax.` |






<a name=".OracleJob.SushiswapExchangeRateTask"></a>

### OracleJob.SushiswapExchangeRateTask
Fetch the swap price from SushiSwap.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| in_token_address | [string](#string) | optional | The input token address. |
| out_token_address | [string](#string) | optional | The output token address. |
| in_token_amount | [double](#double) | optional | The amount of tokens to swap. |
| slippage | [double](#double) | optional | The allowable slippage in percent for the swap. |
| provider | [string](#string) | optional | The RPC provider to use for the swap. |






<a name=".OracleJob.SysclockOffsetTask"></a>

### OracleJob.SysclockOffsetTask
Return the difference between an oracle&#39;s clock and the current timestamp at `SYSVAR_CLOCK_PUBKEY`.






<a name=".OracleJob.Task"></a>

### OracleJob.Task



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| http_task | [OracleJob.HttpTask](#OracleJob.HttpTask) | optional |  |
| json_parse_task | [OracleJob.JsonParseTask](#OracleJob.JsonParseTask) | optional |  |
| median_task | [OracleJob.MedianTask](#OracleJob.MedianTask) | optional |  |
| mean_task | [OracleJob.MeanTask](#OracleJob.MeanTask) | optional |  |
| websocket_task | [OracleJob.WebsocketTask](#OracleJob.WebsocketTask) | optional |  |
| divide_task | [OracleJob.DivideTask](#OracleJob.DivideTask) | optional |  |
| multiply_task | [OracleJob.MultiplyTask](#OracleJob.MultiplyTask) | optional |  |
| lp_token_price_task | [OracleJob.LpTokenPriceTask](#OracleJob.LpTokenPriceTask) | optional |  |
| lp_exchange_rate_task | [OracleJob.LpExchangeRateTask](#OracleJob.LpExchangeRateTask) | optional |  |
| conditional_task | [OracleJob.ConditionalTask](#OracleJob.ConditionalTask) | optional |  |
| value_task | [OracleJob.ValueTask](#OracleJob.ValueTask) | optional |  |
| max_task | [OracleJob.MaxTask](#OracleJob.MaxTask) | optional |  |
| regex_extract_task | [OracleJob.RegexExtractTask](#OracleJob.RegexExtractTask) | optional |  |
| xstep_price_task | [OracleJob.XStepPriceTask](#OracleJob.XStepPriceTask) | optional |  |
| add_task | [OracleJob.AddTask](#OracleJob.AddTask) | optional |  |
| subtract_task | [OracleJob.SubtractTask](#OracleJob.SubtractTask) | optional |  |
| twap_task | [OracleJob.TwapTask](#OracleJob.TwapTask) | optional |  |
| serum_swap_task | [OracleJob.SerumSwapTask](#OracleJob.SerumSwapTask) | optional |  |
| pow_task | [OracleJob.PowTask](#OracleJob.PowTask) | optional |  |
| lending_rate_task | [OracleJob.LendingRateTask](#OracleJob.LendingRateTask) | optional |  |
| mango_perp_market_task | [OracleJob.MangoPerpMarketTask](#OracleJob.MangoPerpMarketTask) | optional |  |
| jupiter_swap_task | [OracleJob.JupiterSwapTask](#OracleJob.JupiterSwapTask) | optional |  |
| perp_market_task | [OracleJob.PerpMarketTask](#OracleJob.PerpMarketTask) | optional |  |
| oracle_task | [OracleJob.OracleTask](#OracleJob.OracleTask) | optional |  |
| anchor_fetch_task | [OracleJob.AnchorFetchTask](#OracleJob.AnchorFetchTask) | optional |  |
| defi_kingdoms_task | [OracleJob.DefiKingdomsTask](#OracleJob.DefiKingdomsTask) | optional |  |
| tps_task | [OracleJob.TpsTask](#OracleJob.TpsTask) | optional |  |
| spl_stake_pool_task | [OracleJob.SplStakePoolTask](#OracleJob.SplStakePoolTask) | optional |  |
| spl_token_parse_task | [OracleJob.SplTokenParseTask](#OracleJob.SplTokenParseTask) | optional |  |
| uniswap_exchange_rate_task | [OracleJob.UniswapExchangeRateTask](#OracleJob.UniswapExchangeRateTask) | optional |  |
| sushiswap_exchange_rate_task | [OracleJob.SushiswapExchangeRateTask](#OracleJob.SushiswapExchangeRateTask) | optional |  |
| pancakeswap_exchange_rate_task | [OracleJob.PancakeswapExchangeRateTask](#OracleJob.PancakeswapExchangeRateTask) | optional |  |
| cache_task | [OracleJob.CacheTask](#OracleJob.CacheTask) | optional |  |
| sysclock_offset_task | [OracleJob.SysclockOffsetTask](#OracleJob.SysclockOffsetTask) | optional |  |
| marinade_state_task | [OracleJob.MarinadeStateTask](#OracleJob.MarinadeStateTask) | optional |  |
| solana_account_data_fetch_task | [OracleJob.SolanaAccountDataFetchTask](#OracleJob.SolanaAccountDataFetchTask) | optional |  |
| buffer_layout_parse_task | [OracleJob.BufferLayoutParseTask](#OracleJob.BufferLayoutParseTask) | optional |  |






<a name=".OracleJob.TpsTask"></a>

### OracleJob.TpsTask
Fetch the current transactions per second.






<a name=".OracleJob.TwapTask"></a>

### OracleJob.TwapTask
Takes a twap over a set period for a certain aggregator.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| aggregator_pubkey | [string](#string) | optional | The target aggregator for the TWAP. |
| period | [int32](#int32) | optional | Period, in seconds, the twap should account for |
| weight_by_propagation_time | [bool](#bool) | optional | Weight samples by their propagation time |
| min_samples | [uint32](#uint32) | optional | Minimum number of samples in the history to calculate a valid result |
| ending_unix_timestamp | [int32](#int32) | optional | Ending unix timestamp to collect values up to |






<a name=".OracleJob.UniswapExchangeRateTask"></a>

### OracleJob.UniswapExchangeRateTask
Fetch the swap price from UniSwap.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| in_token_address | [string](#string) | optional | The input token address. |
| out_token_address | [string](#string) | optional | The output token address. |
| in_token_amount | [double](#double) | optional | The amount of tokens to swap. |
| slippage | [double](#double) | optional | The allowable slippage in percent for the swap. |
| provider | [string](#string) | optional | The RPC provider to use for the swap. |






<a name=".OracleJob.ValueTask"></a>

### OracleJob.ValueTask
Returns a specified value.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| value | [double](#double) | optional | The value that will be returned from this task. |
| aggregator_pubkey | [string](#string) | optional | Specifies an aggregatorr to pull the value of. |
| big | [string](#string) | optional | A stringified big.js. `Accepts variable expansion syntax.` |






<a name=".OracleJob.WebsocketTask"></a>

### OracleJob.WebsocketTask
Opens and maintains a websocket for light speed data retrieval.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| url | [string](#string) | optional | The websocket url. |
| subscription | [string](#string) | optional | The websocket message to notify of a new subscription. |
| max_data_age_seconds | [int32](#int32) | optional | Minimum amount of time required between when the horses are taking out. |
| filter | [string](#string) | optional | Incoming message JSONPath filter. Example: &#34;$[?(@.channel == &#39;ticker&#39; &amp;&amp; @.market == &#39;BTC/USD&#39;)]&#34; |






<a name=".OracleJob.XStepPriceTask"></a>

### OracleJob.XStepPriceTask



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| step_job | [OracleJob.MedianTask](#OracleJob.MedianTask) | optional | median task containing the job definitions to fetch the STEP/USD price |
| step_aggregator_pubkey | [string](#string) | optional | existing aggregator pubkey for STEP/USD |





 


<a name=".OracleJob.BufferLayoutParseTask.BufferParseType"></a>

### OracleJob.BufferLayoutParseTask.BufferParseType


| Name | Number | Description |
| ---- | ------ | ----------- |
| pubkey | 1 | A public key. |
| bool | 2 | A boolean. |
| u8 | 3 | An 8-bit unsigned value. |
| i8 | 4 | An 8-bit signed value. |
| u16 | 5 | A 16-bit unsigned value. |
| i16 | 6 | A 16-bit signed value. |
| u32 | 7 | A 32-bit unsigned value. |
| i32 | 8 | A 32-bit signed value. |
| f32 | 9 | A 32-bit IEEE floating point value. |
| u64 | 10 | A 64-bit unsigned value. |
| i64 | 11 | A 64-bit signed value. |
| f64 | 12 | A 64-bit IEEE floating point value. |
| u128 | 13 | A 128-bit unsigned value. |
| i128 | 14 | A 128-bit signed value. |



<a name=".OracleJob.BufferLayoutParseTask.Endian"></a>

### OracleJob.BufferLayoutParseTask.Endian


| Name | Number | Description |
| ---- | ------ | ----------- |
| LITTLE_ENDIAN | 0 |  |
| BIG_ENDIAN | 1 |  |



<a name=".OracleJob.HttpTask.Method"></a>

### OracleJob.HttpTask.Method
An enumeration representing the types of HTTP requests available to make.

| Name | Number | Description |
| ---- | ------ | ----------- |
| METHOD_UNKOWN | 0 | Unset HTTP method will default to METHOD_GET |
| METHOD_GET | 1 | Perform an HTTP &#39;GET&#39; request. |
| METHOD_POST | 2 | Perform an HTTP &#39;POST&#39; request. |



<a name=".OracleJob.JsonParseTask.AggregationMethod"></a>

### OracleJob.JsonParseTask.AggregationMethod
The methods of combining a list of numerical results.

| Name | Number | Description |
| ---- | ------ | ----------- |
| NONE | 0 |  |
| MIN | 1 | Grab the minimum value of the results. |
| MAX | 2 | Grab the maximum value of the results. |
| SUM | 3 | Sum up all of the results. |



<a name=".OracleJob.LendingRateTask.Field"></a>

### OracleJob.LendingRateTask.Field


| Name | Number | Description |
| ---- | ------ | ----------- |
| FIELD_DEPOSIT_RATE | 0 | deposit lending rate |
| FIELD_BORROW_RATE | 1 | borrow lending rate |


 

 

 



## Scalar Value Types

| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
| <a name="double" /> double |  | double | double | float | float64 | double | float | Float |
| <a name="float" /> float |  | float | float | float | float32 | float | float | Float |
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="bool" /> bool |  | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |