Positions
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
200
Paginated positions
application/json
400
Invalid pubkey format
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
}
get
Get position details
Path parameters
idstringRequired
Position pubkey as hex string
Responses
200
Position details
application/json
400
Invalid pubkey format
application/json
404
Position not found
text/plain
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
}
}
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
200
List of positions
application/json
400
Invalid pubkey format
application/json
404
Position not found for specified pool
text/plain
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
200
List of positions
application/json
400
Invalid pubkey format
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
}
]
Last updated