Chilkat Online Tools

PureBasic / Trader v2 API / Watchlist

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "name": "my first watchlist",
    ;   "symbols": [
    ;     "AAPL",
    ;     "LMND",
    ;     "PLTR",
    ;     "AMZN",
    ;     "CSCO",
    ;     "A"
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"name","my first watchlist")
    CkJsonObject::ckUpdateString(json,"symbols[0]","AAPL")
    CkJsonObject::ckUpdateString(json,"symbols[1]","LMND")
    CkJsonObject::ckUpdateString(json,"symbols[2]","PLTR")
    CkJsonObject::ckUpdateString(json,"symbols[3]","AMZN")
    CkJsonObject::ckUpdateString(json,"symbols[4]","CSCO")
    CkJsonObject::ckUpdateString(json,"symbols[5]","A")

    CkHttp::ckSetRequestHeader(http,"Apca-Api-Secret-Key","{{APCA_API_SECRET_KEY}}")
    CkHttp::ckSetRequestHeader(http,"Apca-Api-Key-Id","{{APCA_API_KEY_ID}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/v2/watchlists","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Apca-Api-Key-Id: {{APCA_API_KEY_ID}}"
	-H "Apca-Api-Secret-Key: {{APCA_API_SECRET_KEY}}"
	-d '{
  "name": "my first watchlist",
  "symbols": ["AAPL","LMND","PLTR","AMZN","CSCO","A"]
}'
https://domain.com/v2/watchlists

Postman Collection Item JSON

{
  "name": "Watchlist",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Apca-Api-Key-Id",
        "value": "{{APCA_API_KEY_ID}}",
        "type": "text"
      },
      {
        "key": "Apca-Api-Secret-Key",
        "value": "{{APCA_API_SECRET_KEY}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"my first watchlist\",\n  \"symbols\": [\"AAPL\",\"LMND\",\"PLTR\",\"AMZN\",\"CSCO\",\"A\"]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v2/watchlists",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v2",
        "watchlists"
      ]
    },
    "description": "| Parameter   | Type          | Requirement |\n|-------------|---------------|:-----------:|\n| `name`      | string        | Required    |\n| `symbols`   | array[string] | Optional    |"
  },
  "response": [
  ]
}