Preprocess

Create a Request to Fetch Metadata

Preprocess is called prior to /construction/payloads to construct a request for any metadata that is needed for transaction construction given (i.e. account nonce). The options object returned from this endpoint will be sent to the /construction/metadata endpoint UNMODIFIED by the caller (in an offline execution environment). If your Construction API implementation has configuration options, they MUST be specified in the /construction/preprocess request (in the metadata field).

post

/construction/preprocess

Body

network_identifierobjectrequired

The network_identifier specifies which network a particular object is associated with.

operationsobject[]required

metadataobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/construction/preprocess' \
  --header 'Content-Type: application/json' \
  --data '{"network_identifier":{"blockchain":"bitcoin","network":"mainnet","sub_network_identifier":{"network":"shard 1","metadata":{"producer":"0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"}}},"operations":[{"operation_identifier":{"index":5,"network_index":0},"related_operations":[{"index":1},{"index":2}],"type":"Transfer","status":"Reverted","account":{"address":"0x3a065000ab4183c6bf581dc1e55a605455fc6d61","sub_account":{"address":"0x6b175474e89094c44da98b954eedeac495271d0f","metadata":{}},"metadata":{}},"amount":{"value":"1238089899992","currency":{"symbol":"BTC","decimals":8,"metadata":{"Issuer":"Satoshi"}},"metadata":{}},"coin_change":{"coin_identifier":{"identifier":"0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1"},"coin_action":"coin_created"},"metadata":{"asm":"304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd01 03301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2","hex":"48304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd012103301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2"}}],"metadata":{}}'

200

500

200

{
  "options": {},
  "required_public_keys": [
    {
      "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
      "sub_account": {
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "metadata": {}
      },
      "metadata": {}
    }
  ]
}

Expected response to a valid request