Skip to main content
POST
/
v2
/
earn
/
create_account
Python (SDK)
from compass_api_sdk import CompassAPI, models


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

    res = compass_api.earn.earn_create_account(chain=models.CreateAccountRequestChain.BASE, sender="0x9a30797cA5467fBaA1D74574886FeC5F79ae407A", owner="0x9a30797cA5467fBaA1D74574886FeC5F79ae407A", estimate_gas=True)

    # Handle response
    print(res)
{
  "transaction": {
    "chainId": "<string>",
    "data": "<string>",
    "from": "<string>",
    "gas": "<string>",
    "to": "<string>",
    "value": "<string>",
    "nonce": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>"
  },
  "earn_account_address": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json

Request to create a compass account.

​
chain
enum<string>
required
Available options:
arbitrum,
base,
ethereum
​
sender
string
required

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

​
owner
string
required

The address that will own and control the compass account

​
estimate_gas
boolean
default:true

Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.

Response

Successful Response

Response containing unsigned transaction to create compass Earn account.

​
transaction
object | null
required

Transaction to create compass account

​
earn_account_address
string
required

Predicted address of the compass earn account that will be deployed