PHP code example of konfig / snaptrade-php-sdk
1. Go to this page and download the library: Download konfig/snaptrade-php-sdk library . Choose the download type require .
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
konfig / snaptrade-php-sdk example snippets
ptrade = new \SnapTrade\Client(
clientId: getenv("SNAPTRADE_CLIENT_ID"),
consumerKey: getenv("SNAPTRADE_CONSUMER_KEY")
);
$result = $snaptrade->accountInformation->getAccountActivities(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
start_date: "2022-01-24",
end_date: "2022-01-24",
offset: 0,
limit: 1,
type: "BUY,SELL,DIVIDEND"
);
$result = $snaptrade->accountInformation->getAccountActivities(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
start_date: "2022-01-24",
end_date: "2022-01-24",
offset: 0,
limit: 1,
type: "BUY,SELL,DIVIDEND"
);
$result = $snaptrade->accountInformation->getAccountBalanceHistory(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631"
);
$result = $snaptrade->accountInformation->getAllAccountPositions(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631"
);
$result = $snaptrade->accountInformation->getUserAccountBalance(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631"
);
$result = $snaptrade->accountInformation->getUserAccountDetails(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631"
);
$result = $snaptrade->accountInformation->getUserAccountOrderDetail(
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->accountInformation->getUserAccountOrders(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
state: "all",
days: 30
);
$result = $snaptrade->accountInformation->getUserAccountRecentOrders(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
only_executed: True
);
$result = $snaptrade->accountInformation->getUserAccountReturnRates(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
timeframes: "ALL,1Y"
);
$result = $snaptrade->accountInformation->getUserHoldings(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->accountInformation->listUserAccounts(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->accountInformation->updateUserAccount(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "accountId_example"
);
$result = $snaptrade->apiStatus->check();
$result = $snaptrade->authentication->deleteSnapTradeUser(
user_id: "snaptrade-user-123"
);
$result = $snaptrade->authentication->listSnapTradeUsers();
$result = $snaptrade->authentication->loginSnapTradeUser(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
broker: "ALPACA",
immediate_redirect: True,
custom_redirect: "https://snaptrade.com",
reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
connection_type: "read",
show_close_button: True,
dark_mode: True,
locale: "pt-BR",
connection_portal_version: "v4"
);
$result = $snaptrade->authentication->registerSnapTradeUser(
user_id: "snaptrade-user-123"
);
$result = $snaptrade->authentication->resetSnapTradeUserSecret(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->deleteConnection(
connection_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->detailBrokerageAuthorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->disableBrokerageAuthorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->listBrokerageAuthorizationAccounts(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->listBrokerageAuthorizations(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->listConnectionAccounts(
connection_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->refreshBrokerageAuthorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->connections->returnRates(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
timeframes: "ALL,1Y"
);
$result = $snaptrade->connections->syncBrokerageAuthorizationTransactions(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->experimentalEndpoints->addSubscription(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
check_interval_seconds: 300,
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->experimentalEndpoints->cancelSubscription(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631"
);
$result = $snaptrade->experimentalEndpoints->getUserAccountOrderDetailV2(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61"
);
$result = $snaptrade->experimentalEndpoints->getUserAccountOrdersV2(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
state: "all",
days: 30
);
$result = $snaptrade->experimentalEndpoints->getUserAccountRecentOrdersV2(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
only_executed: True
);
$result = $snaptrade->experimentalEndpoints->listSubscriptions();
$result = $snaptrade->referenceData->getPartnerInfo();
$result = $snaptrade->referenceData->getStockExchanges();
$result = $snaptrade->referenceData->getSymbols(
substring: "AAPL"
);
$result = $snaptrade->referenceData->getSymbolsByTicker(
query: "query_example"
);
$result = $snaptrade->referenceData->listAllBrokerageAuthorizationType(
brokerage: "QUESTRADE,ALPACA"
);
$result = $snaptrade->referenceData->listAllBrokerageInstruments(
slug: "QUESTRADE"
);
$result = $snaptrade->referenceData->listAllBrokerages();
$result = $snaptrade->referenceData->symbolSearchUserAccount(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
substring: "AAPL"
);
$result = $snaptrade->trading->cancelOrder(
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631"
);
$result = $snaptrade->trading->getCryptocurrencyPairQuote(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
instrument_symbol: "BTC-USD"
);
$result = $snaptrade->trading->getOptionImpact(
order_type: "MARKET",
time_in_force: "Day",
legs: [
[
"instrument" => [
"symbol" => "PBI 250718C00006000",
"instrument_type" => "OPTION",
],
"action" => "BUY_TO_OPEN",
"units" => 1,
]
],
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "",
stop_price: "",
price_effect: "DEBIT"
);
$result = $snaptrade->trading->getOrderImpact(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
action: "BUY",
universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
order_type: "Market",
time_in_force: "Day",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
price: 31.33,
stop: 31.33,
units: 10.5,
notional_value: None
);
$result = $snaptrade->trading->getUserAccountOptionQuotes(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
symbol: "AAPL 251219C00150000"
);
$result = $snaptrade->trading->getUserAccountQuotes(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
symbols: "symbols_example",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
use_ticker: True
);
$result = $snaptrade->trading->placeComplexOrder(
type: "OTO",
orders: [
[
"order_role" => "TRIGGER",
"action" => "BUY",
"instrument" => [
"symbol" => "AAPL",
"type" => "EQUITY",
],
"order_type" => "Market",
"units" => 1,
"time_in_force" => "Day",
"price" => 31.33,
"stop" => 29.5,
]
],
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
client_order_id: "550e8400-e29b-41d4-a716-446655440000"
);
$result = $snaptrade->trading->placeCryptoOrder(
instrument: [
"symbol" => "BTC",
"type" => "CRYPTOCURRENCY",
],
side: "BUY",
type: "MARKET",
time_in_force: "GTC",
amount: "123.45",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "123.45",
stop_price: "123.45",
post_only: False,
expiration_date: "2024-01-01T00:00:00Z"
);
$result = $snaptrade->trading->placeForceOrder(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
action: "BUY",
order_type: "Market",
time_in_force: "Day",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
symbol: "AAPL",
trading_session: "REGULAR",
expiry_date: "2026-08-21T23:27:55.027Z",
price: 31.33,
stop: 31.33,
units: 10.5,
notional_value: None,
client_order_id: "550e8400-e29b-41d4-a716-446655440000"
);
$result = $snaptrade->trading->placeMlegOrder(
order_type: "MARKET",
time_in_force: "Day",
legs: [
[
"instrument" => [
"symbol" => "PBI 250718C00006000",
"instrument_type" => "OPTION",
],
"action" => "BUY_TO_OPEN",
"units" => 1,
]
],
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "",
stop_price: "",
price_effect: "DEBIT"
);
$result = $snaptrade->trading->placeOrder(
trade_id: "139e307a-82f7-4402-b39e-4da7baa87758",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
wait_to_confirm: True
);
$result = $snaptrade->trading->previewCryptoOrder(
instrument: [
"symbol" => "BTC",
"type" => "CRYPTOCURRENCY",
],
side: "BUY",
type: "MARKET",
time_in_force: "GTC",
amount: "123.45",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "123.45",
stop_price: "123.45",
post_only: False,
expiration_date: "2024-01-01T00:00:00Z"
);
$result = $snaptrade->trading->replaceOrder(
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
action: "BUY",
order_type: "Market",
time_in_force: "Day",
account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
price: 31.33,
symbol: "AAPL",
stop: 31.33,
units: 10.5
);
$result = $snaptrade->trading->searchCryptocurrencyPairInstruments(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
base: "BTC",
quote: "USD"
);
json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/passiv/snaptrade-php-sdk.git"
}
],
"