Create a new transaction

post https://sandbox.api.alkemy.finance/1.0/webhook/transactions/strategy/{strategy_id}

This API creates a new transaction and triggers a trade alert or trade mirror for all subscribed users

This API creates a new transaction and triggers a trade alert or trade mirror for all subscribed users. To test the alert in Sandbox, add a phone number through the test_phone parameter to view a sample alert that would be generated when a strategy is executed.

📘
A note on subscribers
Subscribers always have the option to mirror a trade if they have a partner brokerage account connected through Alkemy. They can opt in for confirmation notifications or put turn on auto trade and only receive notifications on executed trades. If not, then they will receive a trade notification only. To learn more about how Alkemy works, check out our website.

Additional validations:

Price is optional only for Market orders, for Limit orders;
The sum of Portfolio weights + Buying power, can't exceed 100, this grand total is your equity.
Only strategies created to be fed via Webhook can post to this endpoint, if your strategy isn't marked as Webhook strategy, your request will be rejected.

Path Params

strategy_id

string

required

Your strategy ID as provided by Alkemy's development team

Body Params

order_id

string

required

The order ID, usually provided by the broker or strategy. The Order ID must be a unique alphanumeric string. If you are integrating without a third-party brokerage or trading platform, provide the Order ID as a random alphanumeric string

symbol

string

required

The symbol of the underlying security

side

string

required

The side of the operation. Accepted values: 'Buy', 'Sell', 'BTO', 'BTC', 'STC', 'STO'

state

string

required

The current status of the transaction. Accepted values: 'Accepted', 'Executed', 'Canceled', 'Replaced', 'Failed'

type

string

required

The type of order being placed. Allowed values: 'Market', 'Limit'

weight

int32

required

The weight of the transaction in your portfolio, must be an integer between 0-100

int32

required

The number of shares you bought/sold in this transaction, must be an integer

price

float

The limit price for open orders or filled price for executed orders

order_created_at

date-time

The order creation timestamp, if nothing is passed, we will assume the API call time

replaced_order_id

string

The ID of an on-chain order that you are replacing

portfolio

array of objects

Current portfolio holdings after the trade has been placed.

portfolio

test_phone

string

A test phone number. This can only be used in Sandbox mode, and must include the area code. Example: +11234567890

buying_power

int32

The weight of the remaining buying power.

Headers

X-API-Key

string

required

The Private key provided by Alkemy

Responses

📘A note on subscribers

201201

400400

404404

409409

412412

500500

📘
A note on subscribers