Chilkat Online Tools

Ruby / Trader v2 API / All Orders

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()

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

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/v2/orders",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

print "Response status code = " + http.get_LastStatus().to_s() + "\n";
print sbResponseBody.getAsString() + "\n";

Curl Command

curl -X GET
	-H "Apca-Api-Key-Id: {{APCA_API_KEY_ID}}"
	-H "Apca-Api-Secret-Key: {{APCA_API_SECRET_KEY}}"
https://domain.com/v2/orders

Postman Collection Item JSON

{
  "name": "All Orders",
  "request": {
    "method": "GET",
    "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"
      }
    ],
    "url": {
      "raw": "{{HOST}}/v2/orders",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v2",
        "orders"
      ],
      "query": [
        {
          "key": "status",
          "value": "open",
          "description": "Order status to be queried. open, closed or all. Defaults to open.",
          "disabled": true
        },
        {
          "key": "limit",
          "value": "50",
          "description": "The maximum number of orders in response. Defaults to 50 and max is 500.",
          "disabled": true
        },
        {
          "key": "after",
          "value": null,
          "description": "The response will include only ones submitted after this timestamp (exclusive.)",
          "disabled": true
        },
        {
          "key": "until",
          "value": null,
          "description": "The response will include only ones submitted until this timestamp (exclusive.)",
          "disabled": true
        },
        {
          "key": "direction",
          "value": "desc",
          "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.",
          "disabled": true
        },
        {
          "key": "nested",
          "value": "true",
          "description": "If true, the result will roll up multi-leg orders under the legs field of primary order.",
          "disabled": true
        },
        {
          "key": "symbols",
          "value": "",
          "description": "A comma-separated list of symbols to filter by (ex. “AAPL,TSLA,MSFT”).",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}