SnapTrade.Net 6.0.48

SnapTrade.Net - C#

Connect brokerage accounts to your app for live positions and trading.

Rate limiting

Two limits apply to requests signed with your clientId. The stricter one wins, and exceeding either returns 429 Too Many Requests.

• Customer-level — 250 requests/minute by default, scoped to your clientId and applied across all endpoints. Reported in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.
• Account-level — 10 requests/minute per account, scoped to (clientId, accountId). All covered operations for one account draw on the same bucket — reading balances and reading positions share it — and enforcement does not depend on the HTTP method, so updating an account consumes the same bucket as reading it. Only enforced for Personal users, and only for integrations it has been rolled out to — it is not yet in force for every Personal integration. It also does not apply on every operation that documents a 429 below. Where it applies it is reported in X-RateLimit-Account-Limit, X-RateLimit-Account-Remaining and X-RateLimit-Account-Reset. Do not read the absence of those headers as proof the limit is off — some configurations omit the rate limit headers while still enforcing the limit, so header absence tells you nothing about your allowance.

On a 429, X-RateLimit-Remaining: 0 means you hit the customer-level limit and X-RateLimit-Account-Remaining: 0 means the account-level one. Wait for the corresponding *-Reset value (seconds) before retrying, or fall back to exponential backoff with jitter.

Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no X-RateLimit-* header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no X-RateLimit-* headers at all — honour Retry-After and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed.

Because the customer-level limit applies everywhere, any signed request can return 429.

OAuth-authenticated requests are an exception. They are not subject to the customer-level limit and do not receive X-RateLimit-Limit, X-RateLimit-Remaining or X-RateLimit-Reset — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the X-RateLimit-Account-* headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from Retry-After and exponential backoff with jitter rather than from the headers.

See https://docs.snaptrade.com/docs/ratelimiting.

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Installation

Using the .NET Core command-line interface (CLI) tools:

dotnet add package SnapTrade.Net

Using the NuGet Command Line Interface (CLI):

nuget install SnapTrade.Net

Using the Package Manager Console:

Install-Package SnapTrade.Net

From within Visual Studio:

1. Open the Solution Explorer.
2. Right-click on a project within your solution.
3. Click on Manage NuGet Packages...
4. Click on the Browse tab and search for "SnapTrade.Net".
5. Click on the "SnapTrade.Net" package, select the appropriate version in the right-tab and click Install.

Getting Started

using System;
using System.Collections.Generic;
using System.Diagnostics;
using SnapTrade.Net.Client;
using SnapTrade.Net.Model;

namespace Example
{
    public class GetAccountActivitiesExample
    {
        public static void Main()
        {
            Snaptrade client = new Snaptrade();
            // Configure custom BasePath if desired
            // client.SetBasePath("https://api.snaptrade.com/api/v1");
            client.SetClientId(System.Environment.GetEnvironmentVariable("SNAPTRADE_CLIENT_ID"));
            client.SetConsumerKey(System.Environment.GetEnvironmentVariable("SNAPTRADE_CONSUMER_KEY"));

            var accountId = "917c8734-8470-4a3e-a18f-57c3f2ee6631";
            var userId = "snaptrade-user-123";
            var userSecret = "adf2aa34-8219-40f7-a6b3-60156985cc61";
            var startDate = DateTime.Parse("2022-01-24"); // The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`. (optional) 
            var endDate = DateTime.Parse("2022-01-24"); // The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`. (optional) 
            var offset = 56; // An integer that specifies the starting point of the paginated results. Default is 0. (optional) 
            var limit = 56; // An integer that specifies the maximum number of transactions to return. Default of 1000. (optional) 
            var type = "BUY,SELL,DIVIDEND"; // Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `TAX` - A tax related fee.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another.   - `SPLIT` - A stock share split.  (optional) 
            
            try
            {
                // List account activities
                PaginatedUniversalActivity result = client.AccountInformation.GetAccountActivities(accountId, userId, userSecret, startDate, endDate, offset, limit, type);
                Console.WriteLine(result);
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling AccountInformationApi.GetAccountActivities: " + e.Message);
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
            catch (ClientException e)
            {
                Console.WriteLine(e.Response.StatusCode);
                Console.WriteLine(e.Response.RawContent);
                Console.WriteLine(e.InnerException);
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.snaptrade.com

Documentation for Models

• Account
• AccountBalance
• AccountBalanceTotal
• AccountBalancesV2Response
• AccountBalancesV2ResponseBuyingPowerInner
• AccountBalancesV2ResponseDataFreshness
• AccountBalancesV2ResponseMargin
• AccountBalancesV2ResponseNetValue
• AccountHoldings
• AccountHoldingsAccount
• AccountInformationGetUserAccountOrderDetailRequest
• AccountInformationGetUserHoldings409Response
• AccountOrder
• AccountOrderGroup
• AccountOrderGroupNullable
• AccountOrderLeg
• AccountOrderRecord
• AccountOrderRecordLeg
• AccountOrderRecordLegInstrument
• AccountOrderRecordNullable
• AccountOrderRecordStatus
• AccountOrderRecordStatusV2
• AccountOrderRecordStatusV2Nullable
• AccountOrderRecordV2
• AccountOrderRecordV2OrderRole
• AccountOrderRecordV2OrderRoleNullable
• AccountOrdersV2Response
• AccountPosition
• AccountSimple
• AccountSyncStatus
• AccountUniversalActivity
• AccountValueHistoryItem
• AccountValueHistoryResponse
• ActionStrict
• ActionStrictWithOptions
• AdrInstrument
• AllAccountOrdersResponse
• AllAccountOrdersResponseDataFreshness
• AllAccountPositionsResponse
• AllAccountPositionsResponseDataFreshness
• AllUserAccountsResponse
• AnnuityAccount
• AnnuityAccountNetValue
• AnnuityAccountSyncStatus
• AuthenticationLoginSnapTradeUser200Response
• Balance
• BalanceCurrency
• BalanceV2CurrencyAmount
• BalanceV2Money
• Brokerage
• BrokerageAuthorization
• BrokerageAuthorizationDataFreshnessMode
• BrokerageAuthorizationDisabledConfirmation
• BrokerageAuthorizationRefreshConfirmation
• BrokerageAuthorizationTransactionsSyncConfirmation
• BrokerageAuthorizationTypeReadOnly
• BrokerageAuthorizationTypeReadOnlyBrokerage
• BrokerageInstrument
• BrokerageInstrumentsResponse
• BrokerageType
• CancelOrderResponse
• CefInstrument
• CfdInstrument
• ChildBrokerageOrderIDs
• ChildBrokerageOrderIDsNullable
• ComplexOrderLeg
• ComplexOrderResponse
• ConnectedAssetPartnerStats
• ConnectionAccount
• ConnectionAccountSyncStatus
• ConnectionAccountsResponse
• CryptoInstrument
• CryptoOrderForm
• CryptoOrderPreview
• CryptoOrderPreviewEstimatedFee
• CryptoTradingInstrument
• CryptocurrencyPair
• CryptocurrencyPairQuote
• Currency
• CurrencyNullable
• DeleteConnectionConfirmation
• DeleteUserResponse
• DepositAccount
• DepositAccountNetValue
• DepositAccountSyncStatus
• DividendAtDate
• EncryptedResponse
• EncryptedResponseEncryptedMessageData
• EtfInstrument
• Exchange
• ExchangeRatePairs
• FigiInstrument
• FigiInstrumentNullable
• FutureInstrument
• FutureOptionInstrument
• HoldingsStatus
• Institution
• InstitutionConnection
• InstitutionConnectionNullable
• Instrument
• InvestmentAccount
• InvestmentAccountNetValue
• LimitOrderType
• LineOfCreditAccount
• LineOfCreditAccountAvailableCredit
• LineOfCreditAccountMinimumPaymentAmount
• LineOfCreditAccountNetValue
• LineOfCreditAccountSyncStatus
• LoginRedirectURI
• ManualTrade
• ManualTradeAndImpact
• ManualTradeBalance
• ManualTradeForm
• ManualTradeFormBracket
• ManualTradeFormComplex
• ManualTradeFormWithOptions
• ManualTradeImpact
• ManualTradePlaceTimeInForceStrict
• ManualTradeReplaceForm
• ManualTradeSymbol
• MarketOrderType
• MlegActionStrict
• MlegInstrumentType
• MlegLeg
• MlegOrderResponse
• MlegOrderTypeStrict
• MlegPriceEffectStrict
• MlegPriceEffectStrictNullable
• MlegTradeForm
• MlegTradingInstrument
• Model400FailedRequestResponse
• Model401FailedRequestResponse
• Model402BrokerageAuthAlreadyDisabledException
• Model402BrokerageAuthDisabledResponse
• Model403FailedRequestResponse
• Model403FeatureNotEnabledResponse
• Model404FailedRequestResponse
• Model425FailedRequestResponse
• Model429TooManyRequestsResponse
• Model500UnexpectedExceptionResponse
• Model501NotImplementedResponse
• Model503BrokerageRequestResponse
• Model503CurrencyConversionUnavailableResponse
• MonthlyDividends
• MutualFundInstrument
• NetContributions
• NetDividend
• NotionalValue
• NotionalValueNullable
• OAuthWebhookBase
• OptionBrokerageSymbol
• OptionChainInner
• OptionChainInnerChainPerRootInner
• OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
• OptionImpact
• OptionInstrument
• OptionLeg
• OptionQuote
• OptionQuoteGreeks
• OptionStrategy
• OptionStrategyLegsInner
• OptionsPosition
• OptionsSymbol
• OptionsSymbolNullable
• OrderTypeConfiguration
• OrderTypeStrict
• OrderUpdatedResponse
• OtherInstrument
• OtherOrderType
• PaginatedUniversalActivity
• PaginationDetails
• PartnerData
• PartnerStats
• PastValue
• PerformanceCustom
• Position
• PositionCurrency
• PositionSymbol
• RateOfReturnObject
• RateOfReturnResponse
• RecentOrdersResponse
• SecurityType
• SessionEvent
• SimpleOrderForm
• SimpleTradeForm
• SimpleTradeInstrument
• SimpleTradeLeg
• SimpleTradeResponse
• SnapTradeHoldingsAccount
• SnapTradeHoldingsTotalValue
• SnapTradeLoginUserRequestBody
• SnapTradeRegisterUserRequestBody
• Status
• StockInstrument
• StopLimitOrderType
• StopLoss
• StopOrderType
• StrategyOrderRecord
• StrategyQuotes
• StrategyQuotesGreek
• SubPeriodReturnRate
• Symbol
• SymbolCurrency
• SymbolExchange
• SymbolNullable
• SymbolQuery
• SymbolsQuotesInner
• TakeProfit
• TaxLot
• TimeInForceStrict
• TokenizedAssetInstrument
• TradeDetectionAddSubscriptionRequest
• TradeDetectionCancelSubscriptionRequest
• TradeDetectionCancelSubscriptionResponse
• TradeDetectionSubscription
• TradingGetUserAccountOptionQuotes410Response
• TradingInstrument
• TradingSearchCryptocurrencyPairInstruments200Response
• TradingSession
• TrailingStop
• TrailingStopLimitOrderType
• TrailingStopNullable
• TrailingStopOrderType
• TransactionsStatus
• USExchange
• UnderlyingCfdInstrument
• UnderlyingOptionInstrument
• UnderlyingSymbol
• UnderlyingSymbolExchange
• UnderlyingSymbolType
• UnderlyingTokenizedAssetInstrument
• UniversalActivity
• UniversalSymbol
• UniversalSymbolNullable
• UserIDandSecret
• ValidatedTradeBody

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.1 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

Author

This C# package is automatically generated by Konfig