Positions

PreviousPrices NextTransactions

Last updated 3 days ago

get

Get details for a user's position in the specified pool

Path parameters

pubkeystringRequired

User's pubkey as hex string

pool_idstringRequired

Pool ID as a hex string

Responses

get

GET /position/{pubkey}/{pool_id} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

{
  "position": {
    "id": "text",
    "invalid": true,
    "poolId": "text",
    "owner": "text"
  },
  "state": {
    "positionId": "text",
    "blockHeight": "text",
    "liquidity": "text",
    "incrementToken0Amount": 1,
    "incrementToken1Amount": 1
  },
  "estimateYield": "text",
  "totalIncrementToken0Amount": 1,
  "totalIncrementToken1Amount": 1
}

get

Get a list of positions owned by the user

Path parameters

pubkeystringRequired

User's pubkey as hex string

Responses

get

GET /positions/{pubkey} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

[
  {
    "position": {
      "id": "text",
      "invalid": true,
      "poolId": "text",
      "owner": "text"
    },
    "state": {
      "positionId": "text",
      "blockHeight": "text",
      "liquidity": "text",
      "incrementToken0Amount": 1,
      "incrementToken1Amount": 1
    },
    "estimateYield": "text",
    "totalIncrementToken0Amount": 1,
    "totalIncrementToken1Amount": 1
  }
]

get

Get position details

Path parameters

idstringRequired

Position pubkey as hex string

Responses

get

GET /position/{id} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

{
  "position": {
    "id": "text",
    "invalid": true,
    "poolId": "text",
    "owner": "text"
  },
  "state": {
    "positionId": "text",
    "blockHeight": "text",
    "liquidity": "text",
    "incrementToken0Amount": 1,
    "incrementToken1Amount": 1
  }
}

post

Get paginated positions for a user that match the specified filter

Path parameters

pubkeystringRequired

User's pubkey as hex string

Body

namearray | nullOptional

min_liquidityinteger | nullOptional

offsetinteger | nullOptional

limitinteger | nullOptional

Responses

post

POST /positions/{pubkey}/by-filter HTTP/1.1
Host: 127.0.0.1:3000
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "name": [
    "text"
  ],
  "min_liquidity": null,
  "offset": null,
  "limit": null
}

{
  "response": [
    {
      "position": {
        "id": "text",
        "invalid": true,
        "poolId": "text",
        "owner": "text"
      },
      "state": {
        "positionId": "text",
        "blockHeight": "text",
        "liquidity": "text",
        "incrementToken0Amount": 1,
        "incrementToken1Amount": 1
      },
      "estimateYield": "text",
      "totalIncrementToken0Amount": 1,
      "totalIncrementToken1Amount": 1
    }
  ],
  "offset": 1
}