Transaction

Initiate Swap

POST
/transaction.initiateSwap

Request Body

application/jsonRequired
currency_inRequiredobject
currency_outRequiredobject
external_accountsRequiredobject
feesarray<object> | null
referencestring
metadataobject

Response Body

Successful response

TypeScript Definitions

Use the response body type in TypeScript.

dataRequiredstring

Error response

TypeScript Definitions

Use the response body type in TypeScript.

errorRequiredobject
curl -X POST "/v1/transaction.initiateSwap" \
  -H "Content-Type: application/json" \
  -d '{
    "currency_in": {
      "value": "string",
      "code": "AUD",
      "decimals": 0,
      "chain": "arbitrum",
      "metadata": "string"
    },
    "currency_out": {
      "value": "string",
      "code": "AUD",
      "decimals": 0,
      "chain": "arbitrum",
      "metadata": "string"
    },
    "external_accounts": {
      "from": {
        "id": "string"
      },
      "to": {
        "id": "string"
      }
    },
    "fees": [
      {
        "type": "direct",
        "value": {
          "value": "string",
          "code": "AUD",
          "decimals": 0,
          "chain": "arbitrum",
          "metadata": "string"
        },
        "label": "string",
        "rate": 0
      }
    ],
    "reference": "string",
    "metadata": {
      "description": "string",
      "proof_of_purpose": {
        "url": "string",
        "name": "string"
      }
    }
  }'
const body = JSON.stringify({
  "currency_in": {
    "value": "string",
    "code": "AUD",
    "decimals": 0,
    "chain": "arbitrum",
    "metadata": "string"
  },
  "currency_out": {
    "value": "string",
    "code": "AUD",
    "decimals": 0,
    "chain": "arbitrum",
    "metadata": "string"
  },
  "external_accounts": {
    "from": {
      "id": "string"
    },
    "to": {
      "id": "string"
    }
  },
  "fees": [
    {
      "type": "direct",
      "value": {
        "value": "string",
        "code": "AUD",
        "decimals": 0,
        "chain": "arbitrum",
        "metadata": "string"
      },
      "label": "string",
      "rate": 0
    }
  ],
  "reference": "string",
  "metadata": {
    "description": "string",
    "proof_of_purpose": {
      "url": "string",
      "name": "string"
    }
  }
})

fetch("/v1/transaction.initiateSwap", {
  body
})
package main

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

func main() {
  url := "/v1/transaction.initiateSwap"
  body := strings.NewReader(`{
    "currency_in": {
      "value": "string",
      "code": "AUD",
      "decimals": 0,
      "chain": "arbitrum",
      "metadata": "string"
    },
    "currency_out": {
      "value": "string",
      "code": "AUD",
      "decimals": 0,
      "chain": "arbitrum",
      "metadata": "string"
    },
    "external_accounts": {
      "from": {
        "id": "string"
      },
      "to": {
        "id": "string"
      }
    },
    "fees": [
      {
        "type": "direct",
        "value": {
          "value": "string",
          "code": "AUD",
          "decimals": 0,
          "chain": "arbitrum",
          "metadata": "string"
        },
        "label": "string",
        "rate": 0
      }
    ],
    "reference": "string",
    "metadata": {
      "description": "string",
      "proof_of_purpose": {
        "url": "string",
        "name": "string"
      }
    }
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "/v1/transaction.initiateSwap"
body = {
  "currency_in": {
    "value": "string",
    "code": "AUD",
    "decimals": 0,
    "chain": "arbitrum",
    "metadata": "string"
  },
  "currency_out": {
    "value": "string",
    "code": "AUD",
    "decimals": 0,
    "chain": "arbitrum",
    "metadata": "string"
  },
  "external_accounts": {
    "from": {
      "id": "string"
    },
    "to": {
      "id": "string"
    }
  },
  "fees": [
    {
      "type": "direct",
      "value": {
        "value": "string",
        "code": "AUD",
        "decimals": 0,
        "chain": "arbitrum",
        "metadata": "string"
      },
      "label": "string",
      "rate": 0
    }
  ],
  "reference": "string",
  "metadata": {
    "description": "string",
    "proof_of_purpose": {
      "url": "string",
      "name": "string"
    }
  }
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "data": "string"
}
{
  "error": {
    "code": "PARSE_ERROR",
    "message": "string"
  }
}