Skip to main content
GET
/
v0
/
matched-event-clusters
Python
import pmxt

router = pmxt.Router(pmxt_api_key="YOUR_PMXT_API_KEY")
clusters = router.fetch_matched_event_clusters(
    query="Satoshi",
    relation="identity",
    min_venues=2,
    include_raw_matches=True,
    limit=5,
)

for cluster in clusters:
    venues = [event.source_exchange for event in cluster.events]
    print(cluster.canonical_title, venues)

Documentation Index

Fetch the complete documentation index at: https://pmxt.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Required when calling the hosted API directly (curl, requests, fetch). SDK users pass credentials via constructor params instead.

Query Parameters

​
eventId
string

Anchor the response to a specific event ID.

​
slug
string

Anchor the response to a specific event slug.

​
url
string

Anchor the response to a specific event URL.

​
query
string

Text search across cluster titles.

​
category
string

Filter both sides of matched edges by event category.

​
relations
string
default:identity

Comma-separated relation filter. Valid values: identity (same resolution), subset (A yes implies B yes), superset (B yes implies A yes), overlap (some shared scenarios), and disjoint (mutually exclusive). Defaults to identity. For subset and superset, direction follows the pairwise edge direction returned in rawMatches when includeRawMatches=true.

​
relation
enum<string>
default:identity

Single relation filter. Alias for relations.

Available options:
identity,
subset,
superset,
overlap,
disjoint
​
minConfidence
number
default:0
Required range: 0 <= x <= 1
​
venues
string

Comma-separated venue allow-list.

​
excludeVenues
string

Comma-separated venue deny-list.

​
minVenues
integer

Minimum number of venues required in a cluster.

Required range: x >= 0
​
withOrderbook
boolean
default:false

Require at least one live orderbook on each matched edge.

​
updatedSince
string<date-time>

Only include matches updated after this timestamp.

​
includeRawMatches
boolean
default:false

Include the pairwise match edges used to build each cluster.

​
sort
enum<string>
default:volume
Available options:
volume,
confidence
​
limit
integer
default:50
Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0
​
edgeLimit
integer

Maximum number of pairwise edges to scan before clustering.

Required range: x >= 1

Response

200

Matched event clusters.