Construction API
Payloads
Given a set of operations, create payloads that must be signed to create a valid ICRC-1 transaction.
POST
/
construction
/
payloads
Create transaction payloads to sign
curl --request POST \
--url 'https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads' \
--header 'Content-Type: application/json' \
--data '
{
"operations": [
{
"operation_identifier": {
"index": 123,
"network_index": 123
},
"related_operations": [
{
"index": 123,
"network_index": 123
}
],
"type": "<string>",
"status": "<string>",
"amount": {
"value": "<string>",
"currency": {
"symbol": "<string>",
"decimals": 123,
"metadata": {}
},
"metadata": {}
},
"metadata": {}
}
],
"metadata": {},
"public_keys": [
{
"hex_bytes": "<string>",
"curve_type": "<string>"
}
]
}
'import requests
url = "https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads"
payload = {
"operations": [
{
"operation_identifier": {
"index": 123,
"network_index": 123
},
"related_operations": [
{
"index": 123,
"network_index": 123
}
],
"type": "<string>",
"status": "<string>",
"amount": {
"value": "<string>",
"currency": {
"symbol": "<string>",
"decimals": 123,
"metadata": {}
},
"metadata": {}
},
"metadata": {}
}
],
"metadata": {},
"public_keys": [
{
"hex_bytes": "<string>",
"curve_type": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
operations: [
{
operation_identifier: {index: 123, network_index: 123},
related_operations: [{index: 123, network_index: 123}],
type: '<string>',
status: '<string>',
amount: {
value: '<string>',
currency: {symbol: '<string>', decimals: 123, metadata: {}},
metadata: {}
},
metadata: {}
}
],
metadata: {},
public_keys: [{hex_bytes: '<string>', curve_type: '<string>'}]
})
};
fetch('https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads', 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://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads",
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([
'operations' => [
[
'operation_identifier' => [
'index' => 123,
'network_index' => 123
],
'related_operations' => [
[
'index' => 123,
'network_index' => 123
]
],
'type' => '<string>',
'status' => '<string>',
'amount' => [
'value' => '<string>',
'currency' => [
'symbol' => '<string>',
'decimals' => 123,
'metadata' => [
]
],
'metadata' => [
]
],
'metadata' => [
]
]
],
'metadata' => [
],
'public_keys' => [
[
'hex_bytes' => '<string>',
'curve_type' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads"
payload := strings.NewReader("{\n \"operations\": [\n {\n \"operation_identifier\": {\n \"index\": 123,\n \"network_index\": 123\n },\n \"related_operations\": [\n {\n \"index\": 123,\n \"network_index\": 123\n }\n ],\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"amount\": {\n \"value\": \"<string>\",\n \"currency\": {\n \"symbol\": \"<string>\",\n \"decimals\": 123,\n \"metadata\": {}\n },\n \"metadata\": {}\n },\n \"metadata\": {}\n }\n ],\n \"metadata\": {},\n \"public_keys\": [\n {\n \"hex_bytes\": \"<string>\",\n \"curve_type\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads")
.header("Content-Type", "application/json")
.body("{\n \"operations\": [\n {\n \"operation_identifier\": {\n \"index\": 123,\n \"network_index\": 123\n },\n \"related_operations\": [\n {\n \"index\": 123,\n \"network_index\": 123\n }\n ],\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"amount\": {\n \"value\": \"<string>\",\n \"currency\": {\n \"symbol\": \"<string>\",\n \"decimals\": 123,\n \"metadata\": {}\n },\n \"metadata\": {}\n },\n \"metadata\": {}\n }\n ],\n \"metadata\": {},\n \"public_keys\": [\n {\n \"hex_bytes\": \"<string>\",\n \"curve_type\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"operations\": [\n {\n \"operation_identifier\": {\n \"index\": 123,\n \"network_index\": 123\n },\n \"related_operations\": [\n {\n \"index\": 123,\n \"network_index\": 123\n }\n ],\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"amount\": {\n \"value\": \"<string>\",\n \"currency\": {\n \"symbol\": \"<string>\",\n \"decimals\": 123,\n \"metadata\": {}\n },\n \"metadata\": {}\n },\n \"metadata\": {}\n }\n ],\n \"metadata\": {},\n \"public_keys\": [\n {\n \"hex_bytes\": \"<string>\",\n \"curve_type\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"unsigned_transaction": "<string>",
"payloads": [
{
"address": "<string>",
"account_identifier": {
"address": "<string>",
"sub_account": {
"address": "<string>",
"metadata": {}
},
"metadata": {}
},
"hex_bytes": "<string>",
"signature_type": "<string>"
}
]
}Create transaction payloads to sign
curl --request POST \
--url 'https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads' \
--header 'Content-Type: application/json' \
--data '
{
"operations": [
{
"operation_identifier": {
"index": 123,
"network_index": 123
},
"related_operations": [
{
"index": 123,
"network_index": 123
}
],
"type": "<string>",
"status": "<string>",
"amount": {
"value": "<string>",
"currency": {
"symbol": "<string>",
"decimals": 123,
"metadata": {}
},
"metadata": {}
},
"metadata": {}
}
],
"metadata": {},
"public_keys": [
{
"hex_bytes": "<string>",
"curve_type": "<string>"
}
]
}
'import requests
url = "https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads"
payload = {
"operations": [
{
"operation_identifier": {
"index": 123,
"network_index": 123
},
"related_operations": [
{
"index": 123,
"network_index": 123
}
],
"type": "<string>",
"status": "<string>",
"amount": {
"value": "<string>",
"currency": {
"symbol": "<string>",
"decimals": 123,
"metadata": {}
},
"metadata": {}
},
"metadata": {}
}
],
"metadata": {},
"public_keys": [
{
"hex_bytes": "<string>",
"curve_type": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
operations: [
{
operation_identifier: {index: 123, network_index: 123},
related_operations: [{index: 123, network_index: 123}],
type: '<string>',
status: '<string>',
amount: {
value: '<string>',
currency: {symbol: '<string>', decimals: 123, metadata: {}},
metadata: {}
},
metadata: {}
}
],
metadata: {},
public_keys: [{hex_bytes: '<string>', curve_type: '<string>'}]
})
};
fetch('https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads', 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://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads",
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([
'operations' => [
[
'operation_identifier' => [
'index' => 123,
'network_index' => 123
],
'related_operations' => [
[
'index' => 123,
'network_index' => 123
]
],
'type' => '<string>',
'status' => '<string>',
'amount' => [
'value' => '<string>',
'currency' => [
'symbol' => '<string>',
'decimals' => 123,
'metadata' => [
]
],
'metadata' => [
]
],
'metadata' => [
]
]
],
'metadata' => [
],
'public_keys' => [
[
'hex_bytes' => '<string>',
'curve_type' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads"
payload := strings.NewReader("{\n \"operations\": [\n {\n \"operation_identifier\": {\n \"index\": 123,\n \"network_index\": 123\n },\n \"related_operations\": [\n {\n \"index\": 123,\n \"network_index\": 123\n }\n ],\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"amount\": {\n \"value\": \"<string>\",\n \"currency\": {\n \"symbol\": \"<string>\",\n \"decimals\": 123,\n \"metadata\": {}\n },\n \"metadata\": {}\n },\n \"metadata\": {}\n }\n ],\n \"metadata\": {},\n \"public_keys\": [\n {\n \"hex_bytes\": \"<string>\",\n \"curve_type\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads")
.header("Content-Type", "application/json")
.body("{\n \"operations\": [\n {\n \"operation_identifier\": {\n \"index\": 123,\n \"network_index\": 123\n },\n \"related_operations\": [\n {\n \"index\": 123,\n \"network_index\": 123\n }\n ],\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"amount\": {\n \"value\": \"<string>\",\n \"currency\": {\n \"symbol\": \"<string>\",\n \"decimals\": 123,\n \"metadata\": {}\n },\n \"metadata\": {}\n },\n \"metadata\": {}\n }\n ],\n \"metadata\": {},\n \"public_keys\": [\n {\n \"hex_bytes\": \"<string>\",\n \"curve_type\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://icrc-mainnet.icp.validationcloud.io/v1/<YOUR_API_KEY_HERE>/construction/payloads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"operations\": [\n {\n \"operation_identifier\": {\n \"index\": 123,\n \"network_index\": 123\n },\n \"related_operations\": [\n {\n \"index\": 123,\n \"network_index\": 123\n }\n ],\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"amount\": {\n \"value\": \"<string>\",\n \"currency\": {\n \"symbol\": \"<string>\",\n \"decimals\": 123,\n \"metadata\": {}\n },\n \"metadata\": {}\n },\n \"metadata\": {}\n }\n ],\n \"metadata\": {},\n \"public_keys\": [\n {\n \"hex_bytes\": \"<string>\",\n \"curve_type\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"unsigned_transaction": "<string>",
"payloads": [
{
"address": "<string>",
"account_identifier": {
"address": "<string>",
"sub_account": {
"address": "<string>",
"metadata": {}
},
"metadata": {}
},
"hex_bytes": "<string>",
"signature_type": "<string>"
}
]
}