Crescent Docs
  • Introduction
    • What is Crescent?
    • Crescent DEX
      • Market
      • Pool (Liquidity Pool)
      • Position
      • Order-book and Tick system
      • Hybrid DEX
      • Batch Matching
      • Sequential Matching
      • Multi-hop Swap(SlipLess Swap)
      • Ranged Liquidity
        • Comparison with Basic position
        • Liquidity Amplification Factor
        • Possibility of Change to a Single-Coin position
        • Multiple Positions in the Pool
      • Fee
      • Farming
        • Current Farming vs Legacy Farming
      • Market Maker Incentives
        • MarketMaker Apply / Incentive Claim
        • MarketMaker Scoring
    • Liquid Staking
      • Staking vs. Liquid Staking
      • Overview of Staking Rewards
      • Calculations for Staking Rewards
      • Liquid Staking Validator
    • Snowball (Liquid AMM)
      • Mint & Burn sb-Token
      • Reward Auction
        • How to Participate
    • Gas and Fees
    • Liquid Governance
    • Partnership
    • Crescent Derivatives
    • Crescent DEX (legacy)
      • Coin Pair
      • Liquidity Pool
      • Legacy Farming Rewards (LP Incentives)
      • New Farming Rewards (LP Incentives)
      • Orderbook and Tick System
      • Hybrid DEX
      • Batch Execution
      • Ranged Pools
      • Market Maker Incentives
        • MarketMaker Apply / Incentive Claim
        • MarketMaker Scoring
      • Synergy with Crescent Boost
  • Developer Guide
    • CLI and API
      • AMM module
        • CLI Reference
        • API Reference
      • Exchange module
        • CLI Reference
        • API Reference
      • LiquidStaking module
        • CLI Reference
        • API Reference
      • LiquidAmm module
        • CLI Reference
        • API Reference
  • Technical Guide
    • Market Maker
    • Farming Planner
  • Other Information
    • Network Configurations
    • Crescent Design Assets
Powered by GitBook
On this page
  • Params
  • PublicPositions
  • PublicPosition
  • RewardsAuctions
  • RewardsAuction
  • Bids
  • Rewards
  1. Developer Guide
  2. CLI and API
  3. LiquidAmm module

API Reference

Params

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/params

Example Response

{
  "params": {
    "rewards_auction_duration": "3600s",
    "max_num_recent_rewards_auctions": 10
  }
}

PublicPositions

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/public_positions

Example Response

{
  "public_positions": [
    {
      "id": "1",
      "pool_id": "1",
      "lower_tick": 35000,
      "upper_tick": 45000,
      "bid_reserve_address": "cre1rkln8d74uhfyc9qp3645xnwks0pd8rsterguf6uugd2g60m37dmqwcapvh",
      "min_bid_amount": "100000",
      "fee_rate": "0.003000000000000000",
      "last_rewards_auction_id": "0",
      "liquidity": "0",
      "position_id": "0",
      "total_share": {
        "denom": "sb1",
        "amount": "0"
      }
    }
  ],
  "pagination": {
    "next_key": null,
    "total": "1"
  }
}

PublicPosition

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1

Example Response

{
  "public_position": {
    "id": "1",
    "pool_id": "1",
    "lower_tick": 35000,
    "upper_tick": 45000,
    "bid_reserve_address": "cre1rkln8d74uhfyc9qp3645xnwks0pd8rsterguf6uugd2g60m37dmqwcapvh",
    "min_bid_amount": "100000",
    "fee_rate": "0.003000000000000000",
    "last_rewards_auction_id": "0",
    "liquidity": "0",
    "position_id": "0",
    "total_share": {
      "denom": "sb1",
      "amount": "0"
    }
  }
}

RewardsAuctions

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards_auctions
http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards_auctions?status=AUCTION_STATUS_STARTED
http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards_auctions?status=AUCTION_STATUS_FINISHED
http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards_auctions?status=AUCTION_STATUS_SKIPPED

Example Response

{
  "rewards_auctions": [
    {
      "public_position_id": "1",
      "id": "1",
      "start_time": "2023-07-05T01:59:28.180826Z",
      "end_time": "2023-07-06T00:00:00Z",
      "status": "AUCTION_STATUS_STARTED",
      "winning_bid": null,
      "rewards": [
      ],
      "fees": [
      ]
    }
  ],
  "pagination": {
    "next_key": null,
    "total": "1"
  }
}

RewardsAuction

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards_auctions/1

Example Response

{
  "rewards_auction": {
    "public_position_id": "1",
    "id": "1",
    "start_time": "2023-07-05T01:59:28.180826Z",
    "end_time": "2023-07-06T00:00:00Z",
    "status": "AUCTION_STATUS_STARTED",
    "winning_bid": null,
    "rewards": [
    ],
    "fees": [
    ]
  }
}

Bids

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards_auctions/1/bids

Example Response

{
  "bids": [
    {
      "public_position_id": "1",
      "rewards_auction_id": "1",
      "bidder": "cre1zaavvzxez0elundtn32qnk9lkm8kmcszxclz6p",
      "share": {
        "denom": "sb1",
        "amount": "1000000"
      }
    }
  ],
  "pagination": {
    "next_key": null,
    "total": "1"
  }
}

Rewards

Example Request

http://localhost:1317/crescent/liquidamm/v1beta1/public_positions/1/rewards

Example Response

{
  "rewards": [
    {
      "denom": "uatom",
      "amount": "50456"
    },
    {
      "denom": "uusd",
      "amount": "749866"
    }
  ]
}
PreviousCLI ReferenceNextMarket Maker

Last updated 1 year ago