List API request logs
Request log of every authenticated call your organization made to
the Platform API (both X-API-Key and dashboard-session requests), newest
first.
Each entry includes the HTTP method, path, status code, machine-readable error code, latency, caller identity (API key vs dashboard session), source IP, user agent, query parameters, and, for failed requests (4xx and 5xx), the response body (capped at 2 KiB). Successful requests are logged without a body.
Filters:
method— GET, POST, PUT, PATCH, DELETEstatus—succeeded(2xx/3xx),failed(4xx+5xx),4xx,5xxpath— substring match, e.g.payouts
Example:
GET /platform/v1/organization/api-logs?status=failed&limit=25
X-API-Key: hp_live_...
Logging starts from the deployment of this feature; earlier traffic is not backfilled. Requests to the log/health endpoints themselves and the WebSocket stream are not logged.
What you see of each entry: your own requests (the same API key, or your
own dashboard session) are always shown in full. For other callers’ requests,
responseBody and query are returned only when your role has view
access to the area of the logged endpoint (for example “Payouts” for a payout
request); otherwise they are null and bodyRedacted is true. The
caller’s ip and userAgent need view access to “Team & roles”.
Credentials and account import keys are always redacted.
Pagination: pagination.total counts matching items up to 10,000 (or up
to the end of the requested page, if that is further). When more match,
total is that limit and pagination.totalCapped is true — show it as
“10,000+”. hasMore stays accurate either way; page with offset until it
is false.
Permissions: requires view access to “Webhooks”.
Authentication: send your organization API key in the X-API-Key header.
Access: read-only and full-access API keys. Dashboard members need view access to Webhooks.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/api-logs \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/api-logs"
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/api-logs', 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/api-logs",
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/api-logs"
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/api-logs")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/api-logs")
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": {
"logs": [
{
"id": "<string>",
"requestId": "1721650000000:host:12345:abcdef:10001",
"method": "POST",
"path": "/platform/v1/organization/lockouts",
"route": "/platform/v1/organization/lockouts",
"statusCode": 400,
"errorCode": "VALIDATION_ERROR",
"latencyMs": 85,
"authType": "api-key",
"apiKeyId": "<string>",
"userId": "<string>",
"ip": "203.0.113.7",
"userAgent": "node-fetch/3.3",
"query": {},
"responseBody": "<string>",
"bodyRedacted": false,
"createdAt": "<string>"
}
],
"pagination": {
"total": 1420,
"totalCapped": false,
"limit": 50,
"offset": 0,
"hasMore": 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": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"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/api-logs \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/api-logs"
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/api-logs', 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/api-logs",
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/api-logs"
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/api-logs")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/api-logs")
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": {
"logs": [
{
"id": "<string>",
"requestId": "1721650000000:host:12345:abcdef:10001",
"method": "POST",
"path": "/platform/v1/organization/lockouts",
"route": "/platform/v1/organization/lockouts",
"statusCode": 400,
"errorCode": "VALIDATION_ERROR",
"latencyMs": 85,
"authType": "api-key",
"apiKeyId": "<string>",
"userId": "<string>",
"ip": "203.0.113.7",
"userAgent": "node-fetch/3.3",
"query": {},
"responseBody": "<string>",
"bodyRedacted": false,
"createdAt": "<string>"
}
],
"pagination": {
"total": 1420,
"totalCapped": false,
"limit": 50,
"offset": 0,
"hasMore": 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": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"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"
}