Skip to main content
POST
/
clients
/
me
/
integrations
/
yield-xyz
/
actions
/
enter
Enter a yield position
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "yieldId": "<string>",
  "address": "<string>",
  "arguments": {
    "amount": "<string>",
    "validatorAddress": "<string>",
    "validatorAddresses": [
      "<string>"
    ],
    "providerId": "<string>",
    "duration": 123,
    "inputToken": "<string>",
    "subnetId": 123,
    "feeConfigurationId": "<string>",
    "cosmosPubKey": "<string>",
    "tezosPubKey": "<string>",
    "cAddressBech": "<string>",
    "pAddressBech": "<string>",
    "ledgerWalletApiCompatible": true,
    "skipPrechecks": true,
    "feePayerAddress": "<string>"
  }
}
'
import requests

url = "https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter"

payload = {
    "yieldId": "<string>",
    "address": "<string>",
    "arguments": {
        "amount": "<string>",
        "validatorAddress": "<string>",
        "validatorAddresses": ["<string>"],
        "providerId": "<string>",
        "duration": 123,
        "inputToken": "<string>",
        "subnetId": 123,
        "feeConfigurationId": "<string>",
        "cosmosPubKey": "<string>",
        "tezosPubKey": "<string>",
        "cAddressBech": "<string>",
        "pAddressBech": "<string>",
        "ledgerWalletApiCompatible": True,
        "skipPrechecks": True,
        "feePayerAddress": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    yieldId: '<string>',
    address: '<string>',
    arguments: {
      amount: '<string>',
      validatorAddress: '<string>',
      validatorAddresses: ['<string>'],
      providerId: '<string>',
      duration: 123,
      inputToken: '<string>',
      subnetId: 123,
      feeConfigurationId: '<string>',
      cosmosPubKey: '<string>',
      tezosPubKey: '<string>',
      cAddressBech: '<string>',
      pAddressBech: '<string>',
      ledgerWalletApiCompatible: true,
      skipPrechecks: true,
      feePayerAddress: '<string>'
    }
  })
};

fetch('https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'yieldId' => '<string>',
    'address' => '<string>',
    'arguments' => [
        'amount' => '<string>',
        'validatorAddress' => '<string>',
        'validatorAddresses' => [
                '<string>'
        ],
        'providerId' => '<string>',
        'duration' => 123,
        'inputToken' => '<string>',
        'subnetId' => 123,
        'feeConfigurationId' => '<string>',
        'cosmosPubKey' => '<string>',
        'tezosPubKey' => '<string>',
        'cAddressBech' => '<string>',
        'pAddressBech' => '<string>',
        'ledgerWalletApiCompatible' => true,
        'skipPrechecks' => true,
        'feePayerAddress' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter"

	payload := strings.NewReader("{\n  \"yieldId\": \"<string>\",\n  \"address\": \"<string>\",\n  \"arguments\": {\n    \"amount\": \"<string>\",\n    \"validatorAddress\": \"<string>\",\n    \"validatorAddresses\": [\n      \"<string>\"\n    ],\n    \"providerId\": \"<string>\",\n    \"duration\": 123,\n    \"inputToken\": \"<string>\",\n    \"subnetId\": 123,\n    \"feeConfigurationId\": \"<string>\",\n    \"cosmosPubKey\": \"<string>\",\n    \"tezosPubKey\": \"<string>\",\n    \"cAddressBech\": \"<string>\",\n    \"pAddressBech\": \"<string>\",\n    \"ledgerWalletApiCompatible\": true,\n    \"skipPrechecks\": true,\n    \"feePayerAddress\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"yieldId\": \"<string>\",\n  \"address\": \"<string>\",\n  \"arguments\": {\n    \"amount\": \"<string>\",\n    \"validatorAddress\": \"<string>\",\n    \"validatorAddresses\": [\n      \"<string>\"\n    ],\n    \"providerId\": \"<string>\",\n    \"duration\": 123,\n    \"inputToken\": \"<string>\",\n    \"subnetId\": 123,\n    \"feeConfigurationId\": \"<string>\",\n    \"cosmosPubKey\": \"<string>\",\n    \"tezosPubKey\": \"<string>\",\n    \"cAddressBech\": \"<string>\",\n    \"pAddressBech\": \"<string>\",\n    \"ledgerWalletApiCompatible\": true,\n    \"skipPrechecks\": true,\n    \"feePayerAddress\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"yieldId\": \"<string>\",\n  \"address\": \"<string>\",\n  \"arguments\": {\n    \"amount\": \"<string>\",\n    \"validatorAddress\": \"<string>\",\n    \"validatorAddresses\": [\n      \"<string>\"\n    ],\n    \"providerId\": \"<string>\",\n    \"duration\": 123,\n    \"inputToken\": \"<string>\",\n    \"subnetId\": 123,\n    \"feeConfigurationId\": \"<string>\",\n    \"cosmosPubKey\": \"<string>\",\n    \"tezosPubKey\": \"<string>\",\n    \"cAddressBech\": \"<string>\",\n    \"pAddressBech\": \"<string>\",\n    \"ledgerWalletApiCompatible\": true,\n    \"skipPrechecks\": true,\n    \"feePayerAddress\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "rawResponse": {
      "transactions": [
        {}
      ],
      "yieldId": "<string>"
    }
  }
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
​
yieldId
string
required

The yield opportunity ID to enter.

​
address
string
required

Wallet address entering the yield position.

​
arguments
object

Optional yield-specific arguments. Which fields are supported depends on the yield opportunity's mechanics.

Response

Enter transactions built successfully

​
data
object