Liquidity#

pydantic model empyrealSDK.types.Liquidity[source]#

Show JSON schema
{
   "title": "Liquidity",
   "type": "object",
   "properties": {
      "token0_balance": {
         "title": "Token0 Balance",
         "type": "integer"
      },
      "token0_price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Token0 Price"
      },
      "token1_balance": {
         "title": "Token1 Balance",
         "type": "integer"
      },
      "token1_price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Token1 Price"
      },
      "pair": {
         "$ref": "#/$defs/DexPair"
      }
   },
   "$defs": {
      "DexFactory": {
         "const": "uniswap",
         "title": "DexFactory"
      },
      "DexPair": {
         "properties": {
            "factory_address": {
               "title": "Factory Address",
               "type": "string"
            },
            "token0": {
               "$ref": "#/$defs/Token"
            },
            "token1": {
               "$ref": "#/$defs/Token"
            },
            "address": {
               "title": "Address",
               "type": "string"
            },
            "index": {
               "title": "Index",
               "type": "integer"
            },
            "fee": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Fee"
            },
            "network": {
               "$ref": "#/$defs/Network"
            },
            "block_number": {
               "title": "Block Number",
               "type": "integer"
            },
            "transaction_hash": {
               "title": "Transaction Hash",
               "type": "string"
            },
            "factory": {
               "$ref": "#/$defs/DexFactory"
            }
         },
         "required": [
            "factory_address",
            "token0",
            "token1",
            "address",
            "index",
            "fee",
            "network",
            "block_number",
            "transaction_hash",
            "factory"
         ],
         "title": "DexPair",
         "type": "object"
      },
      "Network": {
         "const": 1,
         "description": "An enum representing the different Networks supported by the SDK",
         "title": "Network"
      },
      "Token": {
         "description": "An abstraction of an ERC20 token instance",
         "properties": {
            "id": {
               "format": "uuid",
               "title": "Id",
               "type": "string"
            },
            "address": {
               "title": "Address",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "decimals": {
               "title": "Decimals",
               "type": "integer"
            },
            "chainId": {
               "$ref": "#/$defs/Network"
            }
         },
         "required": [
            "id",
            "address",
            "name",
            "symbol",
            "decimals",
            "chainId"
         ],
         "title": "Token",
         "type": "object"
      }
   },
   "required": [
      "token0_balance",
      "token1_balance",
      "pair"
   ]
}

Fields:
  • pair (empyrealSDK.types.dex.DexPair)

  • token0_balance (int)

  • token0_price (float | None)

  • token1_balance (int)

  • token1_price (float | None)

field pair: DexPair [Required]#
field token0_balance: int [Required]#
field token0_price: float | None = None#
field token1_balance: int [Required]#
field token1_price: float | None = None#
property token0_value#
property token1_value#
property value#