@gfxlabs/oku
Version:
Package for interacting with the oku.trade api
1,867 lines (1,858 loc) • 1.35 MB
YAML
openapi: 3.1.0
info:
version: 1.0.21
title: Oku JSON-RPC API
description: >-
Welcome to Oku's API, developed by GFX Labs and made available to the public
by the Uniswap Foundation.
The API has complete historical Uniswap v3 pool, position, swap info, and
much more!
The endpoints listed below were created to support the development of Oku.
The API is JSON-RPC2 compliant (https://www.jsonrpc.org/specification) and
can be accessed via http POST or websocket.
This document details an alternative way to access the jsonrpc2 api, through
post requests in where the URL path is used for the method.
If you can't find the data you're looking for or encounter an error, please
contact the GFX Labs team.
servers:
- url: https://omni.icarus.tools
components:
schemas:
Float64:
type: number
x-go-package: ''
x-go-type: float64
title: Float64
Int:
type: integer
x-go-package: ''
x-go-type: int
title: Int
Int32:
type: integer
x-go-package: ''
x-go-type: int32
title: Int32
Int64:
type: integer
x-go-package: ''
x-go-type: int64
title: Int64
uint256_Int:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
title: uint256_Int
common_Address:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
title: common_Address
common_Hash:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Hash
title: common_Hash
AmountDeltas:
type: object
properties:
amount0_delta:
type: string
amount1_delta:
type: string
required:
- amount0_delta
- amount1_delta
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*AmountDeltas'
title: AmountDeltas
AnalyticsActivityHistory:
type: object
properties:
data:
type: array
items:
type: array
items:
type: integer
x-go-package: ''
x-go-type: int
max_value:
type: integer
x-go-package: ''
x-go-type: int
total_trades:
type: integer
x-go-package: ''
x-go-type: int
required:
- data
- max_value
- total_trades
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*AnalyticsActivityHistory'
title: AnalyticsActivityHistory
TransactionCount:
type: object
properties:
count:
type: integer
x-go-package: ''
x-go-type: int
ts:
type: string
required:
- count
- ts
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*TransactionCount'
title: TransactionCount
AnalyticsDailyActivityHistory:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TransactionCount'
max_value:
type: integer
x-go-package: ''
x-go-type: int
total_trades:
type: integer
x-go-package: ''
x-go-type: int
required:
- data
- max_value
- total_trades
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*AnalyticsDailyActivityHistory'
title: AnalyticsDailyActivityHistory
PositionInfo:
type: object
properties:
percent_change:
type: number
x-go-package: ''
x-go-type: float64
positions_created_24h:
type: integer
x-go-package: ''
x-go-type: int
total_positions:
type: integer
x-go-package: ''
x-go-type: int
required:
- percent_change
- positions_created_24h
- total_positions
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionInfo'
title: PositionInfo
PoolRecentTransactions:
type: object
properties:
amount0:
type: number
x-go-package: ''
x-go-type: float64
amount1:
type: number
x-go-package: ''
x-go-type: float64
current_value:
type: number
x-go-package: ''
x-go-type: float64
event_type:
type: string
side:
type: string
time:
type: integer
x-go-package: ''
x-go-type: int
token0_symbol:
type: string
token1_symbol:
type: string
transaction:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Hash
usd_value:
type: number
x-go-package: ''
x-go-type: float64
user:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
required:
- amount0
- amount1
- current_value
- event_type
- side
- time
- token0_symbol
- token1_symbol
- transaction
- usd_value
- user
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PoolRecentTransactions'
title: PoolRecentTransactions
PositionPriceRange:
type: object
properties:
inverse_lower_price:
type: string
inverse_upper_price:
type: string
lower_price:
type: string
upper_price:
type: string
required:
- inverse_lower_price
- inverse_upper_price
- lower_price
- upper_price
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionPriceRange'
title: PositionPriceRange
Positions:
type: object
properties:
apr:
type: string
collected_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
create_time:
type: string
fee:
type: integer
x-go-package: ''
x-go-type: int
last_event_time:
type: string
pnl:
type: number
x-go-package: ''
x-go-type: float64
pool:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
position_price_range:
$ref: '#/components/schemas/PositionPriceRange'
position_type:
type: string
source:
type: string
status:
type: string
t0:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
t0_amount:
type: string
t0_decimals:
type: integer
x-go-package: ''
x-go-type: int
t0_symbol:
type: string
t1:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
t1_amount:
type: string
t1_decimals:
type: integer
x-go-package: ''
x-go-type: int
t1_symbol:
type: string
tick_lower:
type: integer
x-go-package: ''
x-go-type: int
tick_upper:
type: integer
x-go-package: ''
x-go-type: int
token_id:
type: integer
x-go-package: ''
x-go-type: int
total_value_current_usd:
type: string
user:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
uuid:
type: string
required:
- collected_fees_usd
- create_time
- fee
- last_event_time
- pnl
- pool
- status
- t0
- t0_decimals
- t0_symbol
- t1
- t1_decimals
- t1_symbol
- tick_lower
- tick_upper
- token_id
- total_value_current_usd
- uuid
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*Positions'
title: Positions
AnalyticsPool:
type: object
properties:
address:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
apr:
type: number
x-go-package: ''
x-go-type: float64
apr_change:
type: number
x-go-package: ''
x-go-type: float64
fee:
type: integer
x-go-package: ''
x-go-type: int
last_updated:
type: integer
x-go-package: ''
x-go-type: int
position_stats:
$ref: '#/components/schemas/PositionInfo'
recent_transactions:
type: array
items:
$ref: '#/components/schemas/PoolRecentTransactions'
t0:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
t0_change:
type: number
x-go-package: ''
x-go-type: float64
t0_change_usd:
type: number
x-go-package: ''
x-go-type: float64
t0_decimals:
type: integer
x-go-package: ''
x-go-type: int
t0_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
t0_name:
type: string
t0_price_usd:
type: number
x-go-package: ''
x-go-type: float64
t0_symbol:
type: string
t0_tvl:
type: number
x-go-package: ''
x-go-type: float64
t0_tvl_usd:
type: number
x-go-package: ''
x-go-type: float64
t0_volume:
type: number
x-go-package: ''
x-go-type: float64
t0_volume_7d:
type: number
x-go-package: ''
x-go-type: float64
t0_volume_change:
type: number
x-go-package: ''
x-go-type: float64
t0_volume_change_7d:
type: number
x-go-package: ''
x-go-type: float64
t0_volume_usd:
type: number
x-go-package: ''
x-go-type: float64
t1:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
t1_change:
type: number
x-go-package: ''
x-go-type: float64
t1_change_usd:
type: number
x-go-package: ''
x-go-type: float64
t1_decimals:
type: integer
x-go-package: ''
x-go-type: int
t1_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
t1_name:
type: string
t1_price_usd:
type: number
x-go-package: ''
x-go-type: float64
t1_symbol:
type: string
t1_tvl:
type: number
x-go-package: ''
x-go-type: float64
t1_tvl_usd:
type: number
x-go-package: ''
x-go-type: float64
t1_volume:
type: number
x-go-package: ''
x-go-type: float64
t1_volume_7d:
type: number
x-go-package: ''
x-go-type: float64
t1_volume_change:
type: number
x-go-package: ''
x-go-type: float64
t1_volume_change_7d:
type: number
x-go-package: ''
x-go-type: float64
t1_volume_usd:
type: number
x-go-package: ''
x-go-type: float64
top_positions:
type: array
items:
$ref: '#/components/schemas/Positions'
total_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
tvl_usd:
type: number
x-go-package: ''
x-go-type: float64
tvl_usd_change:
type: number
x-go-package: ''
x-go-type: float64
tx_count:
type: integer
x-go-package: ''
x-go-type: int
volume_and_fees_change:
type: number
x-go-package: ''
x-go-type: float64
required:
- address
- apr
- apr_change
- fee
- last_updated
- position_stats
- recent_transactions
- t0
- t0_change
- t0_change_usd
- t0_decimals
- t0_fees_usd
- t0_name
- t0_price_usd
- t0_symbol
- t0_tvl
- t0_tvl_usd
- t0_volume
- t0_volume_7d
- t0_volume_change
- t0_volume_change_7d
- t0_volume_usd
- t1
- t1_change
- t1_change_usd
- t1_decimals
- t1_fees_usd
- t1_name
- t1_price_usd
- t1_symbol
- t1_tvl
- t1_tvl_usd
- t1_volume
- t1_volume_7d
- t1_volume_change
- t1_volume_change_7d
- t1_volume_usd
- top_positions
- total_fees_usd
- tvl_usd
- tvl_usd_change
- tx_count
- volume_and_fees_change
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*AnalyticsPool'
title: AnalyticsPool
PositionFees:
type: object
properties:
token0BurnedLiquidityCollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token0BurnedLiquidityUncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token0FeesCollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token0FeesUncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token1BurnedLiquidityCollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token1BurnedLiquidityUncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token1FeesCollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token1FeesUncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
required:
- token0BurnedLiquidityCollected
- token0BurnedLiquidityUncollected
- token0FeesCollected
- token0FeesUncollected
- token1BurnedLiquidityCollected
- token1BurnedLiquidityUncollected
- token1FeesCollected
- token1FeesUncollected
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionFees'
title: PositionFees
CurrentValues:
type: object
properties:
amount0_current:
type: string
amount0_current_usd:
type: string
amount1_current:
type: string
amount1_current_usd:
type: string
liquidity_current:
type: string
total_value_current_usd:
type: string
required:
- amount0_current
- amount0_current_usd
- amount1_current
- amount1_current_usd
- liquidity_current
- total_value_current_usd
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*CurrentValues'
title: CurrentValues
EstimatedPositionApr:
type: object
properties:
estimated_apr:
type: number
x-go-package: ''
x-go-type: float64
estimated_fees:
type: number
x-go-package: ''
x-go-type: float64
required:
- estimated_apr
- estimated_fees
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*EstimatedPositionApr'
title: EstimatedPositionApr
HistoricPositionFees:
type: object
properties:
accumulated_fees0_usd:
type: number
x-go-package: ''
x-go-type: float64
accumulated_fees1_usd:
type: number
x-go-package: ''
x-go-type: float64
accumulated_total_usd:
type: number
x-go-package: ''
x-go-type: float64
fees0:
type: number
x-go-package: ''
x-go-type: float64
fees0_usd:
type: number
x-go-package: ''
x-go-type: float64
fees1:
type: number
x-go-package: ''
x-go-type: float64
fees1_usd:
type: number
x-go-package: ''
x-go-type: float64
time:
type: integer
x-go-package: ''
x-go-type: int
total_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
required:
- accumulated_fees0_usd
- accumulated_fees1_usd
- accumulated_total_usd
- fees0
- fees0_usd
- fees1
- fees1_usd
- time
- total_fees_usd
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*HistoricPositionFees'
title: HistoricPositionFees
HistoricPositionFeesInfo:
type: object
properties:
historic_fees:
type: array
items:
$ref: '#/components/schemas/HistoricPositionFees'
total_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
total_fees0:
type: number
x-go-package: ''
x-go-type: float64
total_fees0_usd:
type: number
x-go-package: ''
x-go-type: float64
total_fees1:
type: number
x-go-package: ''
x-go-type: float64
total_fees1_usd:
type: number
x-go-package: ''
x-go-type: float64
required:
- historic_fees
- total_fees_usd
- total_fees0
- total_fees0_usd
- total_fees1
- total_fees1_usd
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*HistoricPositionFeesInfo'
title: HistoricPositionFeesInfo
LastTransactionEvent:
type: object
properties:
last_log_index:
type: integer
x-go-package: ''
x-go-type: int
last_txn_block:
type: integer
x-go-package: ''
x-go-type: int
last_txn_processed:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Hash
required:
- last_log_index
- last_txn_block
- last_txn_processed
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*LastTransactionEvent'
title: LastTransactionEvent
CurrentTxnValues:
type: object
properties:
token0_value_current:
type: number
x-go-package: ''
x-go-type: float64
token1_value_current:
type: number
x-go-package: ''
x-go-type: float64
total_value_current:
type: number
x-go-package: ''
x-go-type: float64
required:
- token0_value_current
- token1_value_current
- total_value_current
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*CurrentTxnValues'
title: CurrentTxnValues
PastTxnValues:
type: object
properties:
token0_value_past:
type: number
x-go-package: ''
x-go-type: float64
token1_value_past:
type: number
x-go-package: ''
x-go-type: float64
total_value_past:
type: number
x-go-package: ''
x-go-type: float64
required:
- token0_value_past
- token1_value_past
- total_value_past
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PastTxnValues'
title: PastTxnValues
PositionTransactions:
type: object
properties:
amount:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount0:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
block:
type: integer
x-go-package: ''
x-go-type: int
current_values:
$ref: '#/components/schemas/CurrentTxnValues'
eventType:
type: string
liquidity:
type: string
logIndex:
type: integer
x-go-package: ''
x-go-type: int
owner:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
past_values:
$ref: '#/components/schemas/PastTxnValues'
pool:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
recipient:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
sender:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
tick_lower:
type: integer
x-go-package: ''
x-go-type: int
tick_upper:
type: integer
x-go-package: ''
x-go-type: int
token_id:
type: integer
x-go-package: ''
x-go-type: int
ts:
type: string
txn:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Hash
txnIndex:
type: integer
x-go-package: ''
x-go-type: int
user:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
required:
- amount
- amount0
- amount1
- block
- eventType
- liquidity
- logIndex
- owner
- pool
- recipient
- sender
- tick_lower
- tick_upper
- token_id
- ts
- txn
- txnIndex
- user
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionTransactions'
title: PositionTransactions
PositionPoolData:
type: object
properties:
current_pool_price:
type: number
x-go-package: ''
x-go-type: float64
current_pool_tick:
type: integer
x-go-package: ''
x-go-type: int
fee:
type: integer
x-go-package: ''
x-go-type: int
pool:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
token0:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
token0_decimals:
type: integer
x-go-package: ''
x-go-type: int
token0_name:
type: string
token0_price:
type: number
x-go-package: ''
x-go-type: float64
token0_price_usd:
type: number
x-go-package: ''
x-go-type: float64
token0_symbol:
type: string
token1:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
token1_decimals:
type: integer
x-go-package: ''
x-go-type: int
token1_name:
type: string
token1_price:
type: number
x-go-package: ''
x-go-type: float64
token1_price_usd:
type: number
x-go-package: ''
x-go-type: float64
token1_symbol:
type: string
required:
- current_pool_price
- current_pool_tick
- fee
- pool
- token0
- token0_decimals
- token0_name
- token0_price
- token0_price_usd
- token0_symbol
- token1
- token1_decimals
- token1_name
- token1_price
- token1_price_usd
- token1_symbol
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionPoolData'
title: PositionPoolData
PositionPnl:
type: object
properties:
amount0_delta:
type: number
x-go-package: ''
x-go-type: float64
amount0_loss:
type: number
x-go-package: ''
x-go-type: float64
amount0_profit:
type: number
x-go-package: ''
x-go-type: float64
amount1_delta:
type: number
x-go-package: ''
x-go-type: float64
amount1_loss:
type: number
x-go-package: ''
x-go-type: float64
amount1_profit:
type: number
x-go-package: ''
x-go-type: float64
collected_usd_fees:
type: number
x-go-package: ''
x-go-type: float64
pnl_usd_after_fees:
type: number
x-go-package: ''
x-go-type: float64
pnl_usd_before_fees:
type: number
x-go-package: ''
x-go-type: float64
uncollected_usd_fees:
type: number
x-go-package: ''
x-go-type: float64
required:
- amount0_delta
- amount0_loss
- amount0_profit
- amount1_delta
- amount1_loss
- amount1_profit
- collected_usd_fees
- pnl_usd_after_fees
- pnl_usd_before_fees
- uncollected_usd_fees
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionPnl'
title: PositionPnl
PositionStartingAmounts:
type: object
properties:
amount0:
type: string
amount1:
type: string
block:
type: integer
x-go-package: ''
x-go-type: int
liquidity:
type: string
log_index:
type: integer
x-go-package: ''
x-go-type: int
mint_tx:
type: string
owner:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
timestamp:
type: string
required:
- amount0
- amount1
- block
- liquidity
- log_index
- mint_tx
- owner
- timestamp
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionStartingAmounts'
title: PositionStartingAmounts
TotalCollectAmounts:
type: object
properties:
total_collect_amount0:
type: string
total_collect_amount1:
type: string
total_net_collect_amount0:
type: string
total_net_collect_amount1:
type: string
required:
- total_collect_amount0
- total_collect_amount1
- total_net_collect_amount0
- total_net_collect_amount1
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*TotalCollectAmounts'
title: TotalCollectAmounts
TotalDepositAmounts:
type: object
properties:
total_deposit_amount0:
type: string
total_deposit_amount1:
type: string
required:
- total_deposit_amount0
- total_deposit_amount1
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*TotalDepositAmounts'
title: TotalDepositAmounts
TotalWithdrawnAmounts:
type: object
properties:
total_withdrawn_amount0:
type: string
total_withdrawn_amount1:
type: string
required:
- total_withdrawn_amount0
- total_withdrawn_amount1
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*TotalWithdrawnAmounts'
title: TotalWithdrawnAmounts
PositionsTransfer:
type: object
properties:
block:
type: integer
x-go-package: ''
x-go-type: int
eventAddress:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
logIndex:
type: integer
x-go-package: ''
x-go-type: int
recipient:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
sender:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
token_id:
type: integer
x-go-package: ''
x-go-type: int
ts:
type: string
txn:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Hash
txnIndex:
type: integer
x-go-package: ''
x-go-type: int
required:
- block
- eventAddress
- logIndex
- recipient
- sender
- token_id
- ts
- txn
- txnIndex
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionsTransfer'
title: PositionsTransfer
HistoricUserPositions:
type: object
properties:
amount_deltas:
$ref: '#/components/schemas/AmountDeltas'
create_block:
type: integer
x-go-package: ''
x-go-type: int
created_date:
type: integer
x-go-package: ''
x-go-type: int
current_fee_info:
$ref: '#/components/schemas/PositionFees'
current_liquidity:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
current_pool_price:
type: number
x-go-package: ''
x-go-type: float64
current_pool_tick:
type: integer
x-go-package: ''
x-go-type: int
current_position_values:
$ref: '#/components/schemas/CurrentValues'
estimated_apr:
$ref: '#/components/schemas/EstimatedPositionApr'
fee_history:
$ref: '#/components/schemas/HistoricPositionFeesInfo'
last_event_time:
type: integer
x-go-package: ''
x-go-type: int
last_owner:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
last_transaction_event:
$ref: '#/components/schemas/LastTransactionEvent'
last_updated:
type: integer
x-go-package: ''
x-go-type: int
pool:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
position_age:
type: integer
x-go-package: ''
x-go-type: int
position_events:
type: array
items:
$ref: '#/components/schemas/PositionTransactions'
position_pool_data:
$ref: '#/components/schemas/PositionPoolData'
position_price_range:
$ref: '#/components/schemas/PositionPriceRange'
position_profit:
$ref: '#/components/schemas/PositionPnl'
position_type:
type: string
starting_amounts:
$ref: '#/components/schemas/PositionStartingAmounts'
status:
type: string
tickLower:
type: integer
x-go-package: ''
x-go-type: int
tickUpper:
type: integer
x-go-package: ''
x-go-type: int
token0_decimals:
type: integer
x-go-package: ''
x-go-type: int
token1_decimals:
type: integer
x-go-package: ''
x-go-type: int
tokenId:
type: string
total_collect_amounts:
$ref: '#/components/schemas/TotalCollectAmounts'
total_deposit_amounts:
$ref: '#/components/schemas/TotalDepositAmounts'
total_withdrawn_amounts:
$ref: '#/components/schemas/TotalWithdrawnAmounts'
transfers:
type: array
items:
$ref: '#/components/schemas/PositionsTransfer'
user:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
uuid:
type: string
required:
- amount_deltas
- create_block
- created_date
- current_fee_info
- current_liquidity
- current_pool_price
- current_pool_tick
- current_position_values
- estimated_apr
- fee_history
- last_event_time
- last_owner
- last_transaction_event
- last_updated
- pool
- position_age
- position_events
- position_pool_data
- position_price_range
- position_profit
- position_type
- starting_amounts
- status
- tickLower
- tickUpper
- token0_decimals
- token1_decimals
- tokenId
- total_collect_amounts
- total_deposit_amounts
- total_withdrawn_amounts
- transfers
- user
- uuid
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*HistoricUserPositions'
title: HistoricUserPositions
PriceRange:
type: object
properties:
current_pool_prices:
type: number
x-go-package: ''
x-go-type: float64
current_pool_tick:
type: integer
x-go-package: ''
x-go-type: int
inverseLowerPrice:
type: number
x-go-package: ''
x-go-type: float64
inverseUpperPrice:
type: number
x-go-package: ''
x-go-type: float64
lowerPrice:
type: number
x-go-package: ''
x-go-type: float64
upperPrice:
type: number
x-go-package: ''
x-go-type: float64
required:
- current_pool_prices
- current_pool_tick
- inverseLowerPrice
- inverseUpperPrice
- lowerPrice
- upperPrice
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PriceRange'
title: PriceRange
RelatedUserPositions:
type: object
properties:
_key:
type: string
amount0_collected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount0_current:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount0_current_usd:
type: string
amount0_deposited:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount0_loss:
type: number
x-go-package: ''
x-go-type: float64
amount0_net_collected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount0_profit:
type: number
x-go-package: ''
x-go-type: float64
amount0_uncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount0_withdrawn:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1_collected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1_current:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1_current_usd:
type: string
amount1_deposited:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1_loss:
type: number
x-go-package: ''
x-go-type: float64
amount1_net_collected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1_profit:
type: number
x-go-package: ''
x-go-type: float64
amount1_uncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
amount1_withdrawn:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
collected_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
create_block:
type: integer
x-go-package: ''
x-go-type: int
create_time:
type: string
current_pool_price:
type: number
x-go-package: ''
x-go-type: float64
current_pool_tick:
type: integer
x-go-package: ''
x-go-type: int
last_event_time:
type: string
last_log_index:
type: integer
x-go-package: ''
x-go-type: int
last_owner:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
last_txn_block:
type: integer
x-go-package: ''
x-go-type: int
last_txn_processed:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Hash
last_updated:
type: integer
x-go-package: ''
x-go-type: int
pnl_usd_after_fees:
type: number
x-go-package: ''
x-go-type: float64
pnl_usd_before_fees:
type: number
x-go-package: ''
x-go-type: float64
pool:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
pool_fee:
type: integer
x-go-package: ''
x-go-type: int
position_type:
type: string
price_range:
$ref: '#/components/schemas/PriceRange'
status:
type: string
t0:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
t0_decimals:
type: integer
x-go-package: ''
x-go-type: int
t0_symbol:
type: string
t1:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
t1_decimals:
type: integer
x-go-package: ''
x-go-type: int
t1_symbol:
type: string
tickLower:
type: integer
x-go-package: ''
x-go-type: int
tickUpper:
type: integer
x-go-package: ''
x-go-type: int
token_id:
type: integer
x-go-package: ''
x-go-type: int
token0_burned_liquidity_collected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token0_burned_liquidity_uncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token1_burned_liquidity_collected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
token1_burned_liquidity_uncollected:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
total_gas_costs:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
total_liquidity:
type: string
minLength: 66
maxLength: 66
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/holiman/uint256
x-go-type: '*Int'
total_value_current_usd:
type: string
uncollected_fees_usd:
type: number
x-go-package: ''
x-go-type: float64
user:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
required:
- _key
- amount0_collected
- amount0_current
- amount0_current_usd
- amount0_deposited
- amount0_loss
- amount0_net_collected
- amount0_profit
- amount0_uncollected
- amount0_withdrawn
- amount1_collected
- amount1_current
- amount1_current_usd
- amount1_deposited
- amount1_loss
- amount1_net_collected
- amount1_profit
- amount1_uncollected
- amount1_withdrawn
- collected_fees_usd
- create_block
- create_time
- current_pool_price
- current_pool_tick
- last_event_time
- last_log_index
- last_owner
- last_txn_block
- last_txn_processed
- last_updated
- pnl_usd_after_fees
- pnl_usd_before_fees
- pool
- pool_fee
- position_type
- price_range
- status
- t0
- t0_decimals
- t0_symbol
- t1
- t1_decimals
- t1_symbol
- tickLower
- tickUpper
- token_id
- token0_burned_liquidity_collected
- token0_burned_liquidity_uncollected
- token1_burned_liquidity_collected
- token1_burned_liquidity_uncollected
- total_gas_costs
- total_liquidity
- total_value_current_usd
- uncollected_fees_usd
- user
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*RelatedUserPositions'
title: RelatedUserPositions
AnalyticsPosition:
type: object
properties:
position:
$ref: '#/components/schemas/HistoricUserPositions'
related_positions:
type: array
items:
$ref: '#/components/schemas/RelatedUserPositions'
required:
- position
- related_positions
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*AnalyticsPosition'
title: AnalyticsPosition
AnalyticsPositionFilter:
type: object
properties:
limit:
type: integer
x-go-package: ''
x-go-type: int
pool:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
tick_lower:
type: integer
x-go-package: ''
x-go-type: int
tick_upper:
type: integer
x-go-package: ''
x-go-type: int
token_id:
type: integer
x-go-package: ''
x-go-type: int
user:
type: string
minLength: 42
maxLength: 42
pattern: ^0x[a-fA-F0-9]*$
x-go-package: github.com/ethereum/go-ethereum/common
x-go-type: Address
uuid:
type: string
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*AnalyticsPositionFilter'
title: AnalyticsPositionFilter
PositionsOverview:
type: object
properties:
percent_change:
type: number
x-go-package: ''
x-go-type: float64
positions_created_24h:
type: integer
x-go-package: ''
x-go-type: int
required:
- percent_change
- positions_created_24h
x-go-package: gfx.cafe/uniswap/go/src/api
x-go-type: '*PositionsOverview'
title: PositionsOverview
ProtocolSwaps:
type: object
properties:
percent_change:
type: number
x-go-package