# Ramses Technical Documentation

## Docs

- [Glossary](https://tech.ramses.xyz/concepts/glossary.md)
- [Concepts Overview](https://tech.ramses.xyz/concepts/overview.md)
- [Concentrated Liquidity & Period-Based Accounting](https://tech.ramses.xyz/concepts/protocol/concentrated-liquidity.md)
- [Fees](https://tech.ramses.xyz/concepts/protocol/fees.md)
- [Token Integration Issues](https://tech.ramses.xyz/concepts/protocol/integration-issues.md)
- [Oracle](https://tech.ramses.xyz/concepts/protocol/oracle.md)
- [Range Orders](https://tech.ramses.xyz/concepts/protocol/range-orders.md)
- [Swaps](https://tech.ramses.xyz/concepts/protocol/swaps.md)
- [The Ramses Protocol](https://tech.ramses.xyz/concepts/ramses-protocol.md)
- [Research](https://tech.ramses.xyz/concepts/research.md)
- [Resources](https://tech.ramses.xyz/concepts/resources.md)
- [Token Contracts & Tokenomics](https://tech.ramses.xyz/concepts/tokenomics.md)
- [Ramses Overview](https://tech.ramses.xyz/concepts/what-is-ramses.md)
- [Calling Flash](https://tech.ramses.xyz/contracts/guides/flash-integrations/calling-flash.md)
- [The Final Contract](https://tech.ramses.xyz/contracts/guides/flash-integrations/final-contract.md)
- [The Flash Callback](https://tech.ramses.xyz/contracts/guides/flash-integrations/flash-callback.md)
- [Getting Started](https://tech.ramses.xyz/contracts/guides/flash-integrations/inheritance-constructors.md)
- [Set Up Your Local Environment](https://tech.ramses.xyz/contracts/guides/local-environment.md)
- [Collecting Fees](https://tech.ramses.xyz/contracts/guides/providing-liquidity/collect-fees.md)
- [Decrease Liquidity](https://tech.ramses.xyz/contracts/guides/providing-liquidity/decrease-liquidity.md)
- [Increase Liquidity](https://tech.ramses.xyz/contracts/guides/providing-liquidity/increase-liquidity.md)
- [Mint a New Position](https://tech.ramses.xyz/contracts/guides/providing-liquidity/mint-a-new-position.md)
- [Set Up Your Contract](https://tech.ramses.xyz/contracts/guides/providing-liquidity/setting-up-your-contract.md)
- [The Full Contract](https://tech.ramses.xyz/contracts/guides/providing-liquidity/the-full-contract.md)
- [Multihop Swaps](https://tech.ramses.xyz/contracts/guides/swaps/multihop-swaps.md)
- [Single Swaps](https://tech.ramses.xyz/contracts/guides/swaps/single-swaps.md)
- [Overview](https://tech.ramses.xyz/contracts/overview.md)
- [RamsesV3Factory](https://tech.ramses.xyz/contracts/reference/core/RamsesV3Factory.md)
- [RamsesV3Pool](https://tech.ramses.xyz/contracts/reference/core/RamsesV3Pool.md)
- [RamsesV3PoolDeployer](https://tech.ramses.xyz/contracts/reference/core/RamsesV3PoolDeployer.md)
- [IERC20Minimal](https://tech.ramses.xyz/contracts/reference/core/interfaces/IERC20Minimal.md)
- [IRamsesV3Factory](https://tech.ramses.xyz/contracts/reference/core/interfaces/IRamsesV3Factory.md)
- [IRamsesV3Pool](https://tech.ramses.xyz/contracts/reference/core/interfaces/IRamsesV3Pool.md)
- [IRamsesV3PoolDeployer](https://tech.ramses.xyz/contracts/reference/core/interfaces/IRamsesV3PoolDeployer.md)
- [IUniswapV3FlashCallback](https://tech.ramses.xyz/contracts/reference/core/interfaces/callback/IUniswapV3FlashCallback.md)
- [IUniswapV3MintCallback](https://tech.ramses.xyz/contracts/reference/core/interfaces/callback/IUniswapV3MintCallback.md)
- [IUniswapV3SwapCallback](https://tech.ramses.xyz/contracts/reference/core/interfaces/callback/IUniswapV3SwapCallback.md)
- [IRamsesV3PoolActions](https://tech.ramses.xyz/contracts/reference/core/interfaces/pool/IRamsesV3PoolActions.md)
- [IRamsesV3PoolDerivedState](https://tech.ramses.xyz/contracts/reference/core/interfaces/pool/IRamsesV3PoolDerivedState.md)
- [IRamsesV3PoolEvents](https://tech.ramses.xyz/contracts/reference/core/interfaces/pool/IRamsesV3PoolEvents.md)
- [IRamsesV3PoolImmutables](https://tech.ramses.xyz/contracts/reference/core/interfaces/pool/IRamsesV3PoolImmutables.md)
- [IRamsesV3PoolOwnerActions](https://tech.ramses.xyz/contracts/reference/core/interfaces/pool/IRamsesV3PoolOwnerActions.md)
- [IRamsesV3PoolState](https://tech.ramses.xyz/contracts/reference/core/interfaces/pool/IRamsesV3PoolState.md)
- [BitMath](https://tech.ramses.xyz/contracts/reference/core/libraries/BitMath.md)
- [FixedPoint128](https://tech.ramses.xyz/contracts/reference/core/libraries/FixedPoint128.md)
- [FixedPoint96](https://tech.ramses.xyz/contracts/reference/core/libraries/FixedPoint96.md)
- [FullMath](https://tech.ramses.xyz/contracts/reference/core/libraries/FullMath.md)
- [Oracle](https://tech.ramses.xyz/contracts/reference/core/libraries/Oracle.md)
- [Position](https://tech.ramses.xyz/contracts/reference/core/libraries/Position.md)
- [SafeCast](https://tech.ramses.xyz/contracts/reference/core/libraries/SafeCast.md)
- [SqrtPriceMath](https://tech.ramses.xyz/contracts/reference/core/libraries/SqrtPriceMath.md)
- [SwapMath](https://tech.ramses.xyz/contracts/reference/core/libraries/SwapMath.md)
- [Tick](https://tech.ramses.xyz/contracts/reference/core/libraries/Tick.md)
- [TickBitmap](https://tech.ramses.xyz/contracts/reference/core/libraries/TickBitmap.md)
- [TickMath](https://tech.ramses.xyz/contracts/reference/core/libraries/TickMath.md)
- [TransferHelper](https://tech.ramses.xyz/contracts/reference/core/libraries/TransferHelper.md)
- [UnsafeMath](https://tech.ramses.xyz/contracts/reference/core/libraries/UnsafeMath.md)
- [Deployment Addresses](https://tech.ramses.xyz/contracts/reference/deployments/deployments.md)
- [Error Codes](https://tech.ramses.xyz/contracts/reference/error-codes.md)
- [FeeCollector](https://tech.ramses.xyz/contracts/reference/gauge/FeeCollector.md)
- [FeeDistributor](https://tech.ramses.xyz/contracts/reference/gauge/FeeDistributor.md)
- [GaugeV3](https://tech.ramses.xyz/contracts/reference/gauge/GaugeV3.md)
- [AccessHub](https://tech.ramses.xyz/contracts/reference/governance/AccessHub.md)
- [Minter](https://tech.ramses.xyz/contracts/reference/governance/Minter.md)
- [VoteModule](https://tech.ramses.xyz/contracts/reference/governance/VoteModule.md)
- [Voter](https://tech.ramses.xyz/contracts/reference/governance/Voter.md)
- [Overview](https://tech.ramses.xyz/contracts/reference/overview.md)
- [NonfungibleTokenPositionDescriptor](https://tech.ramses.xyz/contracts/reference/periphery/NonfungibleTokenPositionDescriptor.md)
- [RamsesV3PositionManager](https://tech.ramses.xyz/contracts/reference/periphery/RamsesV3PositionManager.md)
- [SwapRouter](https://tech.ramses.xyz/contracts/reference/periphery/SwapRouter.md)
- [BlockTimestamp](https://tech.ramses.xyz/contracts/reference/periphery/base/BlockTimestamp.md)
- [ERC721Permit](https://tech.ramses.xyz/contracts/reference/periphery/base/ERC721Permit.md)
- [LiquidityManagement](https://tech.ramses.xyz/contracts/reference/periphery/base/LiquidityManagement.md)
- [Multicall](https://tech.ramses.xyz/contracts/reference/periphery/base/Multicall.md)
- [PeripheryImmutableState](https://tech.ramses.xyz/contracts/reference/periphery/base/PeripheryImmutableState.md)
- [PeripheryPayments](https://tech.ramses.xyz/contracts/reference/periphery/base/PeripheryPayments.md)
- [PeripheryPaymentsWithFee](https://tech.ramses.xyz/contracts/reference/periphery/base/PeripheryPaymentsWithFee.md)
- [PoolInitializer](https://tech.ramses.xyz/contracts/reference/periphery/base/PoolInitializer.md)
- [SelfPermit](https://tech.ramses.xyz/contracts/reference/periphery/base/SelfPermit.md)
- [IERC20Metadata](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IERC20Metadata.md)
- [IERC721Permit](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IERC721Permit.md)
- [IMulticall](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IMulticall.md)
- [INonfungibleTokenPositionDescriptor](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/INonfungibleTokenPositionDescriptor.md)
- [IPeripheryImmutableState](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IPeripheryImmutableState.md)
- [IPeripheryPayments](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IPeripheryPayments.md)
- [IPeripheryPaymentsWithFee](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IPeripheryPaymentsWithFee.md)
- [IPoolInitializer](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IPoolInitializer.md)
- [IQuoter](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IQuoter.md)
- [IQuoterV2](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IQuoterV2.md)
- [IRamsesV3PositionManager](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/IRamsesV3PositionManager.md)
- [ISelfPermit](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/ISelfPermit.md)
- [ISwapRouter](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/ISwapRouter.md)
- [ITickLens](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/ITickLens.md)
- [IERC1271](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/external/IERC1271.md)
- [IERC20PermitAllowed](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/external/IERC20PermitAllowed.md)
- [IWETH9](https://tech.ramses.xyz/contracts/reference/periphery/interfaces/external/IWETH9.md)
- [Quoter](https://tech.ramses.xyz/contracts/reference/periphery/lens/Quoter.md)
- [QuoterV2](https://tech.ramses.xyz/contracts/reference/periphery/lens/QuoterV2.md)
- [TickLens](https://tech.ramses.xyz/contracts/reference/periphery/lens/TickLens.md)
- [Base64](https://tech.ramses.xyz/contracts/reference/periphery/libraries/Base64.md)
- [BytesLib](https://tech.ramses.xyz/contracts/reference/periphery/libraries/BytesLib.md)
- [ChainId](https://tech.ramses.xyz/contracts/reference/periphery/libraries/ChainId.md)
- [HexStrings](https://tech.ramses.xyz/contracts/reference/periphery/libraries/HexStrings.md)
- [LiquidityAmounts](https://tech.ramses.xyz/contracts/reference/periphery/libraries/LiquidityAmounts.md)
- [NFTDescriptor](https://tech.ramses.xyz/contracts/reference/periphery/libraries/NFTDescriptor.md)
- [NFTSVG](https://tech.ramses.xyz/contracts/reference/periphery/libraries/NFTSVG.md)
- [Path](https://tech.ramses.xyz/contracts/reference/periphery/libraries/Path.md)
- [PoolTicksCounter](https://tech.ramses.xyz/contracts/reference/periphery/libraries/PoolTicksCounter.md)
- [PositionKey](https://tech.ramses.xyz/contracts/reference/periphery/libraries/PositionKey.md)
- [TokenRatioSortOrder](https://tech.ramses.xyz/contracts/reference/periphery/libraries/TokenRatioSortOrder.md)
- [TransferHelper](https://tech.ramses.xyz/contracts/reference/periphery/libraries/TransferHelper.md)
- [R33](https://tech.ramses.xyz/contracts/reference/tokens/R33.md)
- [XRAM](https://tech.ramses.xyz/contracts/reference/tokens/xRAM.md)
- [Background](https://tech.ramses.xyz/sdk/guides/01-background.md)
- [Local Development](https://tech.ramses.xyz/sdk/guides/02-local-development.md)
- [Web3 Development Basics](https://tech.ramses.xyz/sdk/guides/03-web3-development-basics.md)
- [Introduction](https://tech.ramses.xyz/sdk/guides/advanced/01-introduction.md)
- [Fetching Pool Data](https://tech.ramses.xyz/sdk/guides/advanced/02-pool-data.md)
- [Active Liquidity](https://tech.ramses.xyz/sdk/guides/advanced/03-active-liquidity.md)
- [Ramses V3 as a Price Oracle](https://tech.ramses.xyz/sdk/guides/advanced/04-price-oracle.md)
- [Range Orders](https://tech.ramses.xyz/sdk/guides/advanced/05-range-orders.md)
- [Liquidity Positions](https://tech.ramses.xyz/sdk/guides/liquidity/01-position-data.md)
- [Minting a Position](https://tech.ramses.xyz/sdk/guides/liquidity/02-minting-position.md)
- [Fetching Positions](https://tech.ramses.xyz/sdk/guides/liquidity/03-fetching-positions.md)
- [Adding & Removing Liquidity](https://tech.ramses.xyz/sdk/guides/liquidity/04-modifying-position.md)
- [Collecting Fees](https://tech.ramses.xyz/sdk/guides/liquidity/05-collecting-fees.md)
- [Swapping and Adding Liquidity](https://tech.ramses.xyz/sdk/guides/liquidity/06-swap-and-add-liquidity.md)
- [Getting a Quote](https://tech.ramses.xyz/sdk/guides/swaps/01-quoting.md)
- [Executing a Trade](https://tech.ramses.xyz/sdk/guides/swaps/02-trading.md)
- [Routing a Swap](https://tech.ramses.xyz/sdk/guides/swaps/03-routing.md)
- [Overview](https://tech.ramses.xyz/sdk/overview.md)
- [Get circulating supply](https://tech.ramses.xyz/users-api-reference/coingecko/get-circulating-supply.md): Returns the circulating supply of RAM tokens (total supply minus locked in xRAM). Data is cached for 5 minutes.
- [Get HyperRAM total supply](https://tech.ramses.xyz/users-api-reference/coingecko/get-hyperram-total-supply.md): Returns the total supply of X33 (HyperRAM) tokens. Data is cached for 5 minutes.
- [Get total supply (FDV)](https://tech.ramses.xyz/users-api-reference/coingecko/get-total-supply-fdv.md): Returns the total supply of RAM tokens for FDV calculation. Data is cached for 5 minutes.
- [Get fee launcher schedules](https://tech.ramses.xyz/users-api-reference/fee-launcher/get-fee-launcher-schedules.md): Returns dynamic fee schedules for new pool launches. Each schedule defines how fees decrease over time after pool creation.
- [Check API health](https://tech.ramses.xyz/users-api-reference/health/check-api-health.md): Returns the indexer status including last indexed timestamp and counts. Returns 503 if the indexer is not ready.
- [Get HyperRAM compound data](https://tech.ramses.xyz/users-api-reference/hyperram/get-hyperram-compound-data.md): Returns X33 (HyperRAM) compound and rebase data with APR calculations for each epoch. Data is cached for 30 seconds.
- [Get all pools](https://tech.ramses.xyz/users-api-reference/pools/get-all-pools.md): Returns all liquidity pools without pagination. Use /pools for filtered and paginated results.
- [Get pools with filtering](https://tech.ramses.xyz/users-api-reference/pools/get-pools-with-filtering.md): Returns liquidity pools with pagination, filtering, and sorting options.
- [Get user legacy positions](https://tech.ramses.xyz/users-api-reference/positions/get-user-legacy-positions.md): Returns pool addresses where the user has legacy (non-CL) liquidity positions.
- [Get protocol information](https://tech.ramses.xyz/users-api-reference/protocol/get-protocol-information.md): Returns protocol-wide token metrics including RAM supply, xRAM staking, emissions, and voting information. Data is cached for 30 seconds.
- [Get pool statistics](https://tech.ramses.xyz/users-api-reference/stats/get-pool-statistics.md): Returns daily statistics for a specific pool. Data is cached for 60 seconds.
- [Get protocol statistics](https://tech.ramses.xyz/users-api-reference/stats/get-protocol-statistics.md): Returns daily protocol-wide statistics combining both legacy and concentrated liquidity pools. Data is cached for 60 seconds.
- [Get all tokens](https://tech.ramses.xyz/users-api-reference/tokens/get-all-tokens.md): Returns all indexed tokens with their current prices.
- [Get live token prices](https://tech.ramses.xyz/users-api-reference/tokens/get-live-token-prices.md): Fetches live USD prices for the given token addresses. Results are cached for 30 seconds.

## OpenAPI Specs

- [json](https://gateway.ramses.xyz/v3/hyperevm/swagger/json)
- [openapi](https://tech.ramses.xyz/api-reference/openapi.json)