Skip to main content
GET
/
v1
/
sky
/
position
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.sky.sky_position(chain=models.V1SkyPositionChain.ETHEREUM, user_address="0xacCEE9C7A5a759f814C7A770e2D8F78d662b1F60")

    # Handle response
    print(res)
{
  "usds_value_of_deposits": "<string>",
  "shares": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.compasslabs.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

​
chain
enum<string>
default:ethereum
required
Available options:
ethereum
​
user_address
string
default:0xacCEE9C7A5a759f814C7A770e2D8F78d662b1F60
required

The user-address of the desired position.

Response

Successful Response

​
usds_value_of_deposits
string
required

The USDS equivalent value of the user's deposits thus far (principal + yield).

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
shares
integer
required