Partner access

Get completed round-trip trades (server-derived)

The trader’s completed round-trip trades — one row per position episode (open-from-flat to back-to-flat), newest exit first. Scale-ins and scale-outs are merged into the episode’s single trade. Render these rows as-is rather than re-pairing fills yourself.

Semantics:

Trades are paired per account and contract (exact full contract symbols, e.g. NQU6 and MNQU6 are distinct).
LIFO matching — a close pairs with the newest open lot.
A flatten or liquidation always ends the episode.
pnl/gross_pnl are gross; fee and commission are reported separately so clients can present net if preferred.
duration_formatted reports sub-second round trips (e.g. an instant liquidation) as <1s.
Positions still open at query time are not included (the round trip isn’t complete yet).
Orders can fill in several executions at different prices. The journal uses each order’s executed quantity and volume-weighted average fill price; executed contracts still count when the rest of the order was cancelled.

Example — partner session token:

curl "https://api.hyperprop.com/platform/v1/user/trading/trades?since=2026-07-01T00:00:00Z" \
  -H "Authorization: Bearer <partner-session-token>"

Example — partner app, with API key headers:

curl "https://api.hyperprop.com/platform/v1/user/trading/trades?since=2026-07-01T00:00:00Z" \
  -H "X-Partner-App-Id: your-app-uuid" \
  -H "X-Partner-App-Secret: your-app-secret" \
  -H "X-Trader-Api-Key: hpk_the_traders_key" \
  -H "X-Trader-Email: trader@example.com"

Partner access (read-only). Approved partner apps can read a trader’s journal on the trader’s behalf, in either of two ways:

API key headers — send X-Partner-App-Id, X-Partner-App-Secret and the trader’s key in X-Trader-Api-Key. Optionally add X-Trader-Email (must match the key’s owner) and X-Partner-Firm (limits results to one firm).
Partner session token — send the token from POST /trade/partner/session as Authorization: Bearer <token>. A token created for one firm only returns that firm’s accounts.

Without a firm, results cover the trader’s accounts at every firm. Partner access is read-only: it works on the journal endpoints only. A bad app secret, trader key or email returns 401; a firm where the trader has no accounts returns 403; repeated failures return 429.

GET

user

trading

trades

Get completed round-trip trades (server-derived)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/user/trading/trades

const options = {method: 'GET'};

fetch('https://api.hyperprop.com/platform/v1/user/trading/trades', 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/user/trading/trades",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/user/trading/trades"

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

	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/user/trading/trades")

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

request = Net::HTTP::Get.new(url)

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

{
  "success": true,
  "data": {
    "trades": [
      {
        "id": "trade-31023653-a76ea170",
        "account_id": "<string>",
        "contract": "NQU6",
        "product": "CME",
        "symbol": "NQ",
        "side": "long",
        "entry_order_id": "<string>",
        "entry_price": 29771.25,
        "entry_time": "2026-07-13T10:00:22.498Z",
        "exit_order_id": "<string>",
        "exit_price": 29774,
        "exit_time": "2026-07-13T10:00:35.260Z",
        "entry_order_ids": [
          "<string>"
        ],
        "exit_order_ids": [
          "<string>"
        ],
        "position_group": "<string>",
        "quantity": 1,
        "duration_ms": 12762,
        "duration_formatted": "12s",
        "pnl": 55,
        "gross_pnl": 55,
        "pnl_ticks": 11,
        "pnl_percent": 0.0092,
        "fee": 3,
        "commission": 0
      }
    ],
    "total": 15,
    "generatedAt": "2026-07-15T19:20:00.000Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Unknown firm",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "No accounts at this firm for this trader",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many failed attempts; retry in a minute",
  "code": "TOO_MANY_REQUESTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Headers

authorization

string

Bearer <token>: the trader's own session, or a partner session token from POST /trade/partner/session

x-partner-app-id

string

Partner access: your partner app id

x-partner-app-secret

string

Partner access: your partner app secret (server-side only)

x-trader-api-key

string

Partner access: the trader's API key (hpk_...)

x-trader-email

string

Partner access, optional: the trader's sign-in email; must match the key's owner

x-partner-firm

string

Partner access, optional: organization id, slug or name; limits results to the trader's accounts at that firm

Query Parameters

accountId

string

Restrict to one trading account (default: all of the user's accounts)

since

string<date-time>

Only trades whose exit is at/after this time (for incremental refreshes)

Response

Completed trades

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Get completed round-trip trades (server-derived)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/user/trading/trades

const options = {method: 'GET'};

fetch('https://api.hyperprop.com/platform/v1/user/trading/trades', 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/user/trading/trades",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/user/trading/trades"

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

	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/user/trading/trades")

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

request = Net::HTTP::Get.new(url)

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

{
  "success": true,
  "data": {
    "trades": [
      {
        "id": "trade-31023653-a76ea170",
        "account_id": "<string>",
        "contract": "NQU6",
        "product": "CME",
        "symbol": "NQ",
        "side": "long",
        "entry_order_id": "<string>",
        "entry_price": 29771.25,
        "entry_time": "2026-07-13T10:00:22.498Z",
        "exit_order_id": "<string>",
        "exit_price": 29774,
        "exit_time": "2026-07-13T10:00:35.260Z",
        "entry_order_ids": [
          "<string>"
        ],
        "exit_order_ids": [
          "<string>"
        ],
        "position_group": "<string>",
        "quantity": 1,
        "duration_ms": 12762,
        "duration_formatted": "12s",
        "pnl": 55,
        "gross_pnl": 55,
        "pnl_ticks": 11,
        "pnl_percent": 0.0092,
        "fee": 3,
        "commission": 0
      }
    ],
    "total": 15,
    "generatedAt": "2026-07-15T19:20:00.000Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Unknown firm",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "No accounts at this firm for this trader",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many failed attempts; retry in a minute",
  "code": "TOO_MANY_REQUESTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Get completed round-trip trades (server-derived)

Headers

Query Parameters

Response