Get an account's event log and session history
Everything support staff need to investigate one account without pulling logs by hand:
- events — the account’s event log (
ACCOUNT_CREATED,STATUS_CHANGED,ACCOUNT_FAILEDwith the violated rule,LOCKOUT_CREATED,PURCHASE_CREATED,FILL_CREATED, …). Same rows asGET /organization/events?accountId=, newest first, without the bulky payload snapshot. - sessions — the account owner’s sign-in and security history since the account became theirs (
ownedSince): successful and failed logins (with IP, user agent and sign-in method), password resets, MFA enabled/disabled, agreement signatures, market-data grants. - devices — devices the owner has used for market data (web / mobile) since
ownedSince, with first/last seen and whether the device session is still active.
The account must belong to your organization; sessions and devices cover that account’s owner only, and nothing from before the account was created or claimed.
When the owner’s Hyperprop login existed before you entered their email as the claim email, sessions and devices are empty and ownerHistoryHidden is true: that login’s sign-in and device history is not shared.
curl -X GET "https://api.hyperprop.com/platform/v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/activity?limit=100" \
-H "X-API-Key: hp_live_your_key_here"
Access: read-only and full-access API keys. Dashboard members need view access to Traders & accounts.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity"
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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity', 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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity",
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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity"
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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity")
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{
"success": true,
"data": {
"accountId": "<string>",
"userId": "<string>",
"ownedSince": "<string>",
"ownerHistoryHidden": false,
"events": [
{
"id": "<string>",
"eventType": "ACCOUNT_FAILED",
"reason": "Max drawdown breached: equity 47,950.00 below floor 48,000.00",
"metadata": {},
"createdAt": "<string>"
}
],
"sessions": [
{
"id": "<string>",
"action": "login_success",
"description": "<string>",
"ipAddress": "203.0.113.7",
"userAgent": "<string>",
"method": "password",
"createdAt": "<string>"
}
],
"devices": [
{
"id": "<string>",
"deviceId": "<string>",
"deviceType": "web",
"userAgent": "<string>",
"ipAddress": "<string>",
"firstSeenAt": "<string>",
"lastSeenAt": "<string>",
"isActive": true
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Your role does not have view access to \"Traders & accounts\"",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Trading account not found",
"code": "ACCOUNT_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Query Parameters
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity"
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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity', 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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity",
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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity"
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://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/activity")
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{
"success": true,
"data": {
"accountId": "<string>",
"userId": "<string>",
"ownedSince": "<string>",
"ownerHistoryHidden": false,
"events": [
{
"id": "<string>",
"eventType": "ACCOUNT_FAILED",
"reason": "Max drawdown breached: equity 47,950.00 below floor 48,000.00",
"metadata": {},
"createdAt": "<string>"
}
],
"sessions": [
{
"id": "<string>",
"action": "login_success",
"description": "<string>",
"ipAddress": "203.0.113.7",
"userAgent": "<string>",
"method": "password",
"createdAt": "<string>"
}
],
"devices": [
{
"id": "<string>",
"deviceId": "<string>",
"deviceType": "web",
"userAgent": "<string>",
"ipAddress": "<string>",
"firstSeenAt": "<string>",
"lastSeenAt": "<string>",
"isActive": true
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Your role does not have view access to \"Traders & accounts\"",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Trading account not found",
"code": "ACCOUNT_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}