Chilkat Online Tools

Swift3 / Broker API / Announcements

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "{{api_key}}"
    http.password = "{{api_secret}}"

    let queryParams = CkoJsonObject()!
    queryParams.update("ca_types", value: "dividend,merger,spinoff,split")
    queryParams.update("since", value: "2021-12-01")
    queryParams.update("until", value: "2021-12-17")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://domain.com/v1/corporate_actions/announcements", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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": [
  ]
}