Limits - Fetch - SQLHTTP

Limits - Fetch

Retrieve E*Trade consumer key rate limits using SQL Server

Prerequisites:

See SQLHTTP easy setup for E*Trade
See API Call documentation for parameter values and other information
Create the stored procedure documented below

Stored Procedure:


CREATE PROCEDURE usp_ETrade_Limits_Fetch(
		@Profile nvarchar(100),
		@Response nvarchar(MAX) OUTPUT,
		@StatusCode int OUTPUT,
		@StatusDescription nvarchar(MAX) OUTPUT)
AS

EXEC usp_ETrade_Auth_Refresh @Profile

DECLARE @URL nvarchar(MAX)
DECLARE @QueryString varchar(MAX)
DECLARE @HTTPSessionID uniqueidentifier
DECLARE @Sandbox bit

SET @Sandbox = SQLHTTP.net.AuthParam(@Profile, 'Sandbox')

IF @Sandbox = 1
	BEGIN
		SET @URL = 'https://etwssandbox.etrade.com'

		EXEC SQLHTTP.net.UrlBuilder   @URL OUTPUT,
					      @Profile,
					      'statuses', 'sandbox', 'rest',
					      'limits'

		EXEC SQLHTTP.net.QueryStringBuilder   @QueryString OUTPUT,
						      @Profile,
						      'oauth_consumer_key', '#ConsumerKey',
						      'oauth_token', '#Token'

		SET @URL = @URL + @QueryString
	END
ELSE
	BEGIN
		SET @URL = 'https://etws.etrade.com'

		EXEC SQLHTTP.net.UrlBuilder @URL OUTPUT,
					    @Profile,
					    'statuses', 'rest',
					    'limits'

		EXEC SQLHTTP.net.QueryStringBuilder @QueryString OUTPUT,
						    @Profile,
						    'oauth_consumer_key', '#ConsumerKey',
						    'oauth_token', '#Token'

		SET @URL = @URL + @QueryString
	END

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

EXEC usp_Etrade_Auth_Header @Profile, @HTTPSessionID, @URL, 'GET'

EXEC SQLHTTP.net.HTTPRequest @HttpSessionID,
			     @URL = @URL,
			     @Method = 'GET',
			     @StatusCode = @StatusCode OUTPUT,
			     @StatusDescription = @StatusDescription OUTPUT,
			     @Response = @Response OUTPUT
GO

CREATE PROCEDURE usp_ETrade_Limits_Fetch(

@Profile nvarchar(100),

@Response nvarchar(MAX) OUTPUT,

@StatusCode int OUTPUT,

@StatusDescription nvarchar(MAX) OUTPUT)

EXEC usp_ETrade_Auth_Refresh @Profile

DECLARE @URL nvarchar(MAX)

DECLARE @QueryString varchar(MAX)

DECLARE @HTTPSessionID uniqueidentifier

DECLARE @Sandbox bit

SET @Sandbox = SQLHTTP.net.AuthParam(@Profile, 'Sandbox')

IF @Sandbox = 1

BEGIN

SET @URL = 'https://etwssandbox.etrade.com'

EXEC SQLHTTP.net.UrlBuilder @URL OUTPUT,

@Profile,

'statuses', 'sandbox', 'rest',

'limits'

EXEC SQLHTTP.net.QueryStringBuilder @QueryString OUTPUT,

@Profile,

'oauth_consumer_key', '#ConsumerKey',

'oauth_token', '#Token'

SET @URL = @URL + @QueryString

END

ELSE

BEGIN

SET @URL = 'https://etws.etrade.com'

EXEC SQLHTTP.net.UrlBuilder @URL OUTPUT,

@Profile,

'statuses', 'rest',

'limits'

EXEC SQLHTTP.net.QueryStringBuilder @QueryString OUTPUT,

@Profile,

'oauth_consumer_key', '#ConsumerKey',

'oauth_token', '#Token'

SET @URL = @URL + @QueryString

END

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

EXEC usp_Etrade_Auth_Header @Profile, @HTTPSessionID, @URL, 'GET'

EXEC SQLHTTP.net.HTTPRequest @HttpSessionID,

@URL = @URL,

@Method = 'GET',

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT,

@Response = @Response OUTPUT



Sample Usage:


DECLARE @Response nvarchar(MAX)
DECLARE @StatusCode int
DECLARE @StatusDescription nvarchar(MAX)

EXEC usp_ETrade_Limits_Fetch
		@Profile = 'My Etrade Sandbox',
		@Response = @Response OUTPUT,
		@StatusCode = @StatusCode OUTPUT, 
		@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400
  EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response
ELSE
  IF SQLHTTP.net.IsXmlValid(@Response) = 0
	BEGIN
		RAISERROR(@Response, 16, 1)
		RETURN
	END
  ELSE
	BEGIN
		DECLARE @X xml
		SET @X = CONVERT(xml, CONVERT(varchar(MAX), @Response))

		--The XPath syntax below was easily generated by executing the following commands:
		--EXEC SQLHTTP.net.XQueryHelper @X
		--and then executing: 
		--EXEC SQLHTTP.net.XQueryHelper @X, 'RateLimitStatus' --

		SELECT T.C.value(N'consumerKey[1]', N'nvarchar(MAX)') AS [consumerKey]
		      ,T.C.value(N'limitIntervalInSeconds[1]', N'nvarchar(MAX)') AS [limitIntervalInSeconds]
		      ,T.C.value(N'requestsLimit[1]', N'nvarchar(MAX)') AS [requestsLimit]
		      ,T.C.value(N'requestsRemaining[1]', N'nvarchar(MAX)') AS [requestsRemaining]
		      ,T.C.value(N'resetTime[1]', N'nvarchar(MAX)') AS [resetTime]
		FROM @X.nodes(N'/RateLimitStatus') T(C)
	END

DECLARE @Response nvarchar(MAX)

DECLARE @StatusCode int

DECLARE @StatusDescription nvarchar(MAX)

EXEC usp_ETrade_Limits_Fetch

@Profile = 'My Etrade Sandbox',

@Response = @Response OUTPUT,

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400

EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response

ELSE

IF SQLHTTP.net.IsXmlValid(@Response) = 0

BEGIN

RAISERROR(@Response, 16, 1)

RETURN

END

ELSE

BEGIN

DECLARE @X xml

SET @X = CONVERT(xml, CONVERT(varchar(MAX), @Response))

--The XPath syntax below was easily generated by executing the following commands:

--EXEC SQLHTTP.net.XQueryHelper @X

--and then executing:

--EXEC SQLHTTP.net.XQueryHelper @X, 'RateLimitStatus' --

SELECT T.C.value(N'consumerKey[1]', N'nvarchar(MAX)') AS [consumerKey]

,T.C.value(N'limitIntervalInSeconds[1]', N'nvarchar(MAX)') AS [limitIntervalInSeconds]

,T.C.value(N'requestsLimit[1]', N'nvarchar(MAX)') AS [requestsLimit]

,T.C.value(N'requestsRemaining[1]', N'nvarchar(MAX)') AS [requestsRemaining]

,T.C.value(N'resetTime[1]', N'nvarchar(MAX)') AS [resetTime]

FROM @X.nodes(N'/RateLimitStatus') T(C)

END

consumerKey limitIntervalInSeconds requestsLimit requestsRemaining resetTime

----------------- ----------------------- -------------- ------------------ ---------------------------

sandboxconsumer1 3600 3200 3200 07-22-2009 18:42:42 GMT



IMPORTANT DISCLAIMER

CODE/SQL ON THESE PAGES ARE PROVIDED AS-IS AND ARE AVAILABLE FOR ILLUSTRATIVE PURPOSES ONLY.

USERS ARE REQUIRED TO ABIDE BY THE TERMS AND CONDITIONS FOR USING REFERENCED THIRD PARTY WEBSITES AND/OR APIs FROM THEIR RESPECTIVE WEBSITES. WE DO NOT CONDONE ANY VIOLATION OF THIRD PARTY WEBSITES AND/OR APIs TERMS AND CONDITIONS USING OUR SOFTWARE.

USERS SHALL BE SOLELY RESPONSIBLE AND BE SOLELY LIABLE FOR VIOLATION OF ANY RULES SPECIFIED BY THIRD PARTIES FOR USING THEIR WEBSITES AND/OR APIs, OR INFRINGEMENT OF RIGHTS OF SUCH THIRD PARTIES.