Chilkat Online Tools

SQL Server / Broker API / Announcements

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{api_key}}'
    EXEC sp_OASetProperty @http, 'Password', '{{api_secret}}'

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ca_types', 'dividend,merger,spinoff,split'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'since', '2021-12-01'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'until', '2021-12-17'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/v1/corporate_actions/announcements', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams


END
GO

Curl Command

curl -G -d "ca_types=dividend,merger,spinoff,split"
	-d "since=2021-12-01"
	-d "until=2021-12-17"
	-u '{{api_key}}:{{api_secret}}'
https://domain.com/v1/corporate_actions/announcements

Postman Collection Item JSON

{
  "name": "Announcements",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{HOST}}/v1/corporate_actions/announcements?ca_types=dividend,merger,spinoff,split&since=2021-12-01&until=2021-12-17",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "corporate_actions",
        "announcements"
      ],
      "query": [
        {
          "key": "ca_types",
          "value": "dividend,merger,spinoff,split",
          "description": "A comma-delimited list of ENUM.CorporateActionType values"
        },
        {
          "key": "since",
          "value": "2021-12-01",
          "description": "The start (inclusive) of the date range when searching corporate action announcements. This should follow the YYYY-MM-DD format. The date range is limited to 90 days."
        },
        {
          "key": "until",
          "value": "2021-12-17",
          "description": "The end (inclusive) of the date range when searching corporate action announcements. This should follow the YYYY-MM-DD format. The date range is limited to 90 days."
        },
        {
          "key": "symbol",
          "value": "",
          "description": "The symbol of the company initiating the announcement.",
          "disabled": true
        },
        {
          "key": "cusip",
          "value": "",
          "description": "The CUSIP of the company initiating the announcement.",
          "disabled": true
        },
        {
          "key": "date_type",
          "value": "",
          "description": "ENUM.DateType. Potential values are declaration_date, ex_date, record_date, or payable_date",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}