Prepare a buy

curl --request POST \
  --url https://partners-api.sandbox.securitize.io/stocks/v1/stocks/on-ramp/{contractAddress}/prepare-execute-transaction \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "investorId": "6b31c0e9a4f2d17e85c3b904",
  "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl",
  "slippageBps": "50",
  "liquidityAmount": "1000000000",
  "minOutputAmount": "4302702702"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    investorId: '6b31c0e9a4f2d17e85c3b904',
    signedPrice: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl',
    slippageBps: '50',
    liquidityAmount: '1000000000',
    minOutputAmount: '4302702702'
  })
};

fetch('https://partners-api.sandbox.securitize.io/stocks/v1/stocks/on-ramp/{contractAddress}/prepare-execute-transaction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://partners-api.sandbox.securitize.io/stocks/v1/stocks/on-ramp/{contractAddress}/prepare-execute-transaction"

payload = {
    "investorId": "6b31c0e9a4f2d17e85c3b904",
    "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl",
    "slippageBps": "50",
    "liquidityAmount": "1000000000",
    "minOutputAmount": "4302702702"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "unsignedTransaction": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA…",
  "additionalData": {
    "anchorPrice": "231250000000000000000",
    "operator": "Gp3ratorRoutr9sXcR8yLmB3hW9sJdE6aK1uNqG5tYpC"
  }
}

{
  "statusCode": 400,
  "message": "EXPIRED_PRICE",
  "error": "Bad Request"
}

{
  "message": "No API key found in request"
}

{
  "statusCode": 403,
  "message": "UNAUTHORIZED_INVESTOR",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "SYMBOL_NOT_FOUND",
  "error": "Not Found"
}

{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests"
}

Trading

Prepare a buy

Builds the transaction that buys the stock with USDC, for the investor’s linked wallet, at the price in signedPrice. Securitize checks the investor’s eligibility, the market status, the order size and the price’s freshness, then returns the transaction with the signed price and the swap already in it and Securitize’s own signature on it. Securitize pays the network fee: the investor needs no funds for it.

Have the investor’s wallet sign the returned transaction without modifying it and submit it with POST /stocks/execute-signed-transaction within 120 seconds. Any change invalidates it on chain and the trade reverts.

POST

stocks

on-ramp

{contractAddress}

prepare-execute-transaction

Prepare a buy

curl --request POST \
  --url https://partners-api.sandbox.securitize.io/stocks/v1/stocks/on-ramp/{contractAddress}/prepare-execute-transaction \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "investorId": "6b31c0e9a4f2d17e85c3b904",
  "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl",
  "slippageBps": "50",
  "liquidityAmount": "1000000000",
  "minOutputAmount": "4302702702"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    investorId: '6b31c0e9a4f2d17e85c3b904',
    signedPrice: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl',
    slippageBps: '50',
    liquidityAmount: '1000000000',
    minOutputAmount: '4302702702'
  })
};

fetch('https://partners-api.sandbox.securitize.io/stocks/v1/stocks/on-ramp/{contractAddress}/prepare-execute-transaction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://partners-api.sandbox.securitize.io/stocks/v1/stocks/on-ramp/{contractAddress}/prepare-execute-transaction"

payload = {
    "investorId": "6b31c0e9a4f2d17e85c3b904",
    "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl",
    "slippageBps": "50",
    "liquidityAmount": "1000000000",
    "minOutputAmount": "4302702702"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "unsignedTransaction": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA…",
  "additionalData": {
    "anchorPrice": "231250000000000000000",
    "operator": "Gp3ratorRoutr9sXcR8yLmB3hW9sJdE6aK1uNqG5tYpC"
  }
}

{
  "statusCode": 400,
  "message": "EXPIRED_PRICE",
  "error": "Bad Request"
}

{
  "message": "No API key found in request"
}

{
  "statusCode": 403,
  "message": "UNAUTHORIZED_INVESTOR",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "SYMBOL_NOT_FOUND",
  "error": "Not Found"
}

{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests"
}

Authorizations

x-api-key

string

header

required

Your API key, issued by Securitize. Send it in the x-api-key header on every request. The key identifies your partner account; investorId names the investor each call concerns.

Path Parameters

contractAddress

string

required

The stock's buy contract address, from your Securitize contact. A stock has a different address for selling.

Body

application/json

investorId

string

required

Securitize's id for the investor. The transaction is built for their linked wallet.

signedPrice

string

required

signedPrice from GET /stocks/realtime-price, unchanged and unexpired, for this stock.

slippageBps

string

required

The slippage the investor accepted, in basis points, as a string of digits. Recorded with the order; the bound enforced on chain is minOutputAmount.

Pattern: ^\d+$

liquidityAmount

string

required

USDC to spend, in base units (6 decimals).

Pattern: ^\d+$

minOutputAmount

string

required

The fewest stock tokens the investor accepts, in the token's base units. Below this, the trade reverts and nothing moves. Work it out as liquidityAmount ÷ 10^6 ÷ bestAsk × (1 − slippageBps ÷ 10,000) × 10^tokenDecimals, rounded down.

Pattern: ^\d+$

Response

The transaction for the investor's wallet to sign.

unsignedTransaction

string

required

A base64-encoded transaction for the stock's chain, already signed by Securitize and awaiting the investor's signature. Have it signed unchanged and submit it within 120 seconds.

additionalData

object

Show child attributes

Get started

Guides

Concepts

Help

API reference

Prepare a buy

Authorizations

Path Parameters

Body

Response