Chilkat Online Tools

Ruby / Trader v2 API / Watchlist

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("name","my first watchlist")
json.UpdateString("symbols[0]","AAPL")
json.UpdateString("symbols[1]","LMND")
json.UpdateString("symbols[2]","PLTR")
json.UpdateString("symbols[3]","AMZN")
json.UpdateString("symbols[4]","CSCO")
json.UpdateString("symbols[5]","A")

http.SetRequestHeader("Apca-Api-Secret-Key","{{APCA_API_SECRET_KEY}}")
http.SetRequestHeader("Apca-Api-Key-Id","{{APCA_API_KEY_ID}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/v2/watchlists","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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