Organization

List API request logs

Stripe-style 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 the response body (capped at 2 KiB).

Filters:

method — GET, POST, PUT, PATCH, DELETE
status — succeeded (2xx/3xx), failed (4xx+5xx), 4xx, 5xx
path — 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.

Permissions: requires view access to “Webhooks”.

Authentication: Accepts either Authorization: Bearer <jwt> (dashboard) or X-API-Key: hp_live_... (programmatic).

GET

organization

api-logs

List API request logs

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/api-logs \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<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 => [
    "Authorization: <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("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

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["Authorization"] = '<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>",
        "createdAt": "<string>"
      }
    ],
    "pagination": {
      "total": 1420,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "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": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Query Parameters

method

enum<string>

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

status

enum<string>

Available options:

succeeded,

failed,

4xx,

5xx

path

string

Substring match on the request path

Maximum string length: 200

limit

integer

default:50

Required range: 1 <= x <= 100

offset

integer

default:0

Required range: x >= 0

Response

Paginated API request logs, newest first

success

boolean

Example:

true

data

object

Show child attributes

⌘I

List API request logs

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/api-logs \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<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 => [
    "Authorization: <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("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

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["Authorization"] = '<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>",
        "createdAt": "<string>"
      }
    ],
    "pagination": {
      "total": 1420,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "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": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

List API request logs

Authorizations

Query Parameters

Response