How do I set the API key?

Set the API key as an environment variable: export PEERLYTICS_API_KEY=pk_live_your_key. This key must be present to access the API.

How do I filter by currency or platform?

ParseFilters are case-insensitive. Use currency=X (e.g., currency=USD) or platform=X (e.g., platform=revolut). Always append includeRates=true.

What does includeRates=true do and what about errors?

includeRates=true returns full rate distributions and suggested rates. If you receive 401, the API key is invalid; 429 means rate-limited. In non-200 responses, review the response body for details.

market

npx machina-cli add skill ADWilkinson/peer-tools/market --openclaw

Files (1)

SKILL.md

1.9 KB

You are a ZKP2P market intelligence assistant. Fetch and present market data from the Peerlytics API.

Arguments: $ARGUMENTS

Instructions

Check API key: If PEERLYTICS_API_KEY is not set, tell the user: "Set your API key: export PEERLYTICS_API_KEY=pk_live_your_key -- get one at https://peerlytics.xyz/developers"
Parse filters (case-insensitive):
- Currency codes (GBP, EUR, USD, BRL, TRY, NGN, INR, etc.) -> currency=X
- Platform names (revolut, wise, monzo, pix, zelle, etc.) -> platform=X
- No filter -> general market summary
Always append includeRates=true for full rate distribution data.
Fetch data:

curl -s -D /tmp/peerlytics_headers -w '\n%{http_code}' \
  -H "x-api-key: $PEERLYTICS_API_KEY" \
  "https://peerlytics.xyz/api/v1/market/summary?includeRates=true&FILTERS"

Then read credits remaining: grep -i 'x-credits-remaining' /tmp/peerlytics_headers

Handle errors: 401 = bad key, 429 = rate limited. Show the response body for any non-200.
Present results: Inspect the JSON response and present ALL data returned -- aggregate metrics, rate distributions, breakdowns by currency/platform, suggested rates, etc. Use tables for structured data, format currency values with $ and commas, rates as percentages. If the response contains breakdown sections (by currency, by platform), show each as its own table. Do not omit any fields.
Footer: Report credits remaining (from X-Credits-Remaining header). Suggest: filter by currency/platform if unfiltered, /peerlytics:analytics for volume trends, /peerlytics:leaderboard for top participants, /peerlytics:explorer to look up specific deposits.

</market>

Source

git clone https://github.com/ADWilkinson/peer-tools/blob/main/peerlytics/skills/market/SKILL.mdView on GitHub

Overview

Fetch and present ZKP2P market intelligence from the Peerlytics API. It surfaces liquidity, rate distributions, and suggested rates, with optional filters by currency or platform. Always request includeRates to get full distribution data and breakdowns.

How This Skill Works

Authenticate with the PEERLYTICS_API_KEY, apply filters by currency or platform, and request the market summary endpoint with includeRates=true. The response includes aggregate metrics, rate distributions, and breakdowns by currency and platform; monitor usage via the X-Credits-Remaining header and handle errors (401 or 429) by inspecting the response body.

When to Use It

Obtain a general market snapshot with no filters to gauge overall liquidity and rate activity.
Fetch liquidity and rate distributions for a specific currency (e.g., USD, EUR).
Get platform-specific rate breakdowns (e.g., revolut, wise, monzo) to compare performance.
Compare rate distributions across multiple currencies or platforms to identify best markets.
Investigate volume trends or top participants using additional endpoints like /peerlytics:analytics, /peerlytics:leaderboard, or /peerlytics:explorer.

Quick Start

Step 1: Set API key with: export PEERLYTICS_API_KEY=pk_live_your_key
Step 2: Choose filters, e.g., currency=USD or platform=revolut, and includeRates=true
Step 3: Run curl -s -H "x-api-key: $PEERLYTICS_API_KEY" "https://peerlytics.xyz/api/v1/market/summary?includeRates=true&FILTERS" and review the JSON tables

Best Practices

Set and validate the PEERLYTICS_API_KEY before every query.
Always include includeRates=true to fetch complete rate distribution data.
Filter by currency codes or platform names using case-insensitive mapping (e.g., currency=USD, platform=revolut).
Review all fields in the JSON response; preserve aggregate metrics, distributions, and breakdowns.
Check X-Credits-Remaining after each call and use analytics/leaderboard/explorer endpoints for deeper insights.

Example Use Cases

Retrieve USD liquidity and rate distribution across Revolut and Wise to decide where to transact.
Fetch EUR market summary with per-platform rate breakdowns to compare options.
Get a full market snapshot for all currencies to spot global liquidity hotspots.
Filter by BRL on a specific platform to compare liquidity and rates across providers.
Use /peerlytics:analytics to study volume trends and identify growing markets.

Frequently Asked Questions

Add this skill to your agents