API ReferenceExecution
Read native positions with caller venue credentials
const url = 'https://exec.predictefy.com/v1/exec/hyperliquid/positions';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"owner":"0x2222222222222222222222222222222222222222","signer":"0x1111111111111111111111111111111111111111","accessToken":"YOUR_PRED_ACCESS_TOKEN"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://exec.predictefy.com/v1/exec/hyperliquid/positions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "owner": "0x2222222222222222222222222222222222222222", "signer": "0x1111111111111111111111111111111111111111", "accessToken": "YOUR_PRED_ACCESS_TOKEN" }'Requires a platform API key with the trade scope and an armed venue lane. No Idempotency-Key is required. The JSON body carries the caller's own venue credentials and is forwarded unchanged for this read only, never logged or persisted. PRED requires owner, signer, and accessToken; use this POST form instead of GET. Lanes without a native positions read answer 501 NOT_SUPPORTED.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Execution venue slug. Availability is deployment-specific; discover armed lanes with GET /v1/exec/venues. Settlement-only lanes may appear but report order verbs false.
Request Bodyrequired
Section titled “Request Bodyrequired”Caller-owned venue credentials, forwarded unchanged for one read and never logged or persisted. PRED requires owner (Safe wallet), signer (its EOA), and accessToken (caller JWT). Other lanes may require different fields; no credential is looked up from a platform account id.
object
PRED caller's Safe wallet address.
PRED EOA signer address, different from owner.
Caller-owned PRED access JWT, used only for this request.
Examples
Caller-owned PRED JWT and wallet headers
{ "owner": "0x2222222222222222222222222222222222222222", "signer": "0x1111111111111111111111111111111111111111", "accessToken": "YOUR_PRED_ACCESS_TOKEN"}Responses
Section titled “Responses”Venue-native positions; shape is lane-specific.
object
object
Venue-native position row when the lane implements one.
object
Present only for the fill-derived fallback.
object
Example
{ "success": true, "meta": { "derivation": "fills" }}Invalid route query, body, or lifecycle state.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Predictefy authentication failed, or the venue rejected the caller credential.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The API key lacks trade scope or the venue geofence rejected the request.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}No runtime execution lane is registered for this venue.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The authenticated execution token bucket is exhausted.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Unexpected internal execution failure.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The venue lane has no native capability for this account read.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}A venue request or relay failed ambiguously.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The execution service is unavailable or the venue blocks its egress region.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}