Retrieve a trade

GET /api/v1/trades/{id}

Retrieve a trade

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/trades/{id} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://app.sure.am/api/v1/trades/{id}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.sure.am/api/v1/trades/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sure.am/api/v1/trades/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sure.am/api/v1/trades/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/trades/{id}")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/trades/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "amount": "<string>",
  "currency": "<string>",
  "name": "<string>",
  "qty": 123,
  "price": "<string>",
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "investment_activity_label": "<string>",
  "security": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ticker": "<string>",
    "name": "<string>"
  },
  "category": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ]
}

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Path Parameters

id · string · required

Trade ID

Response

200

application/json

trade retrieved

id · string<uuid> · required

date · string<date> · required

amount · string · required

Formatted monetary amount (e.g. "$1,234.56")

currency · string · required

name · string · required

qty · number · required

Quantity of shares or units traded. Negative for sells.

price · string · required

Formatted price per unit

account · object · required

Show child attributes

created_at · string<date-time> · required

updated_at · string<date-time> · required

notes · string | null

investment_activity_label · string | null

Activity label such as Buy, Sell, Dividend, etc.

security · object | null

Show child attributes

category · object | null

Show child attributes