Fetch matched market clusters - PMXT

Python

import pmxt

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

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

import { Router } from "pmxtjs";

const router = new Router({ pmxtApiKey: "YOUR_PMXT_API_KEY" });

async function main() {
  const clusters = await router.fetchMatchedMarketClusters({
    query: "Satoshi",
    relation: "identity",
    minVenues: 2,
    includeRawMatches: true,
    limit: 5,
  });

  for (const cluster of clusters) {
    console.log(
      cluster.canonicalTitle,
      cluster.markets.map((market) => market.sourceExchange),
    );
  }
}

main();

curl -G "https://api.pmxt.dev/v0/matched-market-clusters" \
  -H "Authorization: Bearer $PMXT_API_KEY" \
  --data-urlencode "query=Satoshi" \
  --data-urlencode "relation=identity" \
  --data-urlencode "minVenues=2" \
  --data-urlencode "includeRawMatches=true" \
  --data-urlencode "limit=5"

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pmxt.dev/v0/matched-market-clusters"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

GET

/

v0

/

matched-market-clusters

Python

import pmxt

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

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

import { Router } from "pmxtjs";

const router = new Router({ pmxtApiKey: "YOUR_PMXT_API_KEY" });

async function main() {
  const clusters = await router.fetchMatchedMarketClusters({
    query: "Satoshi",
    relation: "identity",
    minVenues: 2,
    includeRawMatches: true,
    limit: 5,
  });

  for (const cluster of clusters) {
    console.log(
      cluster.canonicalTitle,
      cluster.markets.map((market) => market.sourceExchange),
    );
  }
}

main();

curl -G "https://api.pmxt.dev/v0/matched-market-clusters" \
  -H "Authorization: Bearer $PMXT_API_KEY" \
  --data-urlencode "query=Satoshi" \
  --data-urlencode "relation=identity" \
  --data-urlencode "minVenues=2" \
  --data-urlencode "includeRawMatches=true" \
  --data-urlencode "limit=5"

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pmxt.dev/v0/matched-market-clusters"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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

marketId

string

Anchor the response to a specific market ID.

slug

string

Anchor the response to a specific market slug.

url

string

Anchor the response to a specific market URL.

query

string

Text search across cluster titles.

category

string

Filter both sides of matched edges by market 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 market clusters.