Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 4.48 KB

README.md

File metadata and controls

67 lines (48 loc) · 4.48 KB
Raw

GM_TOKEN

1.1.12 v3

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required? Name Description Type Options Default
✅ ARBITRUM_RPC_URL RPC url of Arbitrum node string
✅ ARBITRUM_CHAIN_ID The chain id to connect to number 42161
✅ DATASTORE_CONTRACT_ADDRESS Address of Data Store contract string 0xFD70de6b91282D8017aA4E741e9Ae325CAb992d8
✅ READER_CONTRACT_ADDRESS Address of Reader contract string 0xf60becbba223EEA9495Da3f606753867eC10d139
✅ PNL_FACTOR_TYPE PnL factor type. See https://github.com/gmx-io/gmx-synthetics#market-token-price string MAX_PNL_FACTOR_FOR_TRADERS
✅ TIINGO_ADAPTER_URL URL of Tiingo EA string
✅ NCFX_ADAPTER_URL URL of NCFX EA string
✅ COINMETRICS_ADAPTER_URL URL of Coinmetrics EA string
✅ MIN_REQUIRED_SOURCE_SUCCESS Minimum number of source EAs that need to successfully return a value. number 2
BACKGROUND_EXECUTE_MS The amount of time the background execute should sleep before performing the next request number 10000

Data Provider Rate Limits

There are no rate limits for this adapter.

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string price price

Price Endpoint

price is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ index Index token. Long and short tokens will be opened / closed based on this price feed. string
✅ long Long token. This is the token that will back long positions. string
✅ short Short token. This is the token that will back short positions. string
✅ market Market address of the market pool. string

Example

Request:

{
  "data": {
    "endpoint": "price",
    "index": "LINK",
    "long": "LINK",
    "short": "USDC",
    "market": "0x7f1fa204bb700853D36994DA19F830b6Ad18455C"
  }
}

MIT License