PMWallets
中文

Method list

Every call in both languages.

Every call takes the API key you built the client with. Account management that needs you signed in (API keys, adding a webhook, starting or changing a plan) stays on the website.

Board and wallets

NodePythonWhat it does
leaderboard(query)leaderboard(**query)the board, filtered and sorted · HTTP details
periods()periods()the published windows (30d, 7d) and when each was computed
entity(id)entity(id)one wallet in full, by handle or address
latency()latency()measured push latency

Addresses

NodePythonWhat it does
buyReveal({ entityId, maxPriceCents })buy_reveal(id, max_price_cents)buy an address from the balance; never charges more than the ceiling · HTTP details
unlockWithPlan(id)unlock_with_plan(id)unlock with your plan's allowance; never charges
myAddresses(query)my_addresses(**query)every address you unlocked, how you hold it (unlockedBy) and its push status
reveals()reveals()your address purchases

Push and fills

NodePythonWhat it does
subscribe({ entityId, channels })subscribe(id, channels)follow a wallet's fills (per hour, or a plan's free slot)
subscriptions()subscriptions()active and paused subscriptions
cancelSubscription(id)cancel_subscription(id)stop one
resumeSubscription(id)resume_subscription(id)resume a paused one
fills(cursor) / fillsSince(cursor)fills(...) / fills_since(cursor)replay fills after a cursor (one page / every page)

Signals and radar

NodePythonWhat it does
signals(opts)signals(**query)smart-money signals, or what your own rule fired
radar(opts)radar(smart, **query)large taker fills across the market
signalRules() / saveSignalRule(kind, rule)signal_rules() / save_signal_rule(kind, rule)read or set your push rules
walletGroups() / createWalletGroup(name)wallet_groups() / create_wallet_group(name)your wallet groups
editWalletGroup(id, change) / deleteWalletGroup(id)edit_wallet_group(id, **change) / delete_wallet_group(id)change or delete a group
quickAddWallets(id, filters)quick_add_wallets(id, count, **filters)fill a group from the board
followedWalletGroup()followed_wallet_group()the wallets you follow, as a group

Plans, invites and status

NodePythonWhat it does
quotePlanChange(tier)quote_plan_change(tier)what changing plan would do today; never charges
buyPlan({ tier, maxCents, requestId })buy_plan(tier, max_cents=, request_id=)30 days from the balance; keep requestId across retries
me()me()the account behind the key
invite() / invitees() / bindInviteCode(code)invite() / invitees() / bind_invite_code(code)your invite code, invitees and binding a code
markets()markets()the busiest markets, as aggregates
ready() / latencyShape() / latencyIncidents()ready() / latency_shape() / latency_incidents()service status and measured latency

Trade-history exports

NodePythonWhat it does
exportWindow()export_window()the days that can be bought now
exportRateCard()export_rate_card()the per-day prices
exportQuote(input)export_quote(...)price an export without buying
createExport(input)create_export(...)buy it from the balance · HTTP details
createPlanExport(ids)create_plan_export(ids)the whole window from your plan's export allowance
exports() / getExport(id) / exportFiles(id)exports() / get_export(id) / export_files(id)your exports and the daily files each grants
downloadExportFile(wallet, day)download_export_file(wallet, day)download one file (the key is never sent to storage)

Account

NodePythonWhat it does
plan()plan()your plan, its period dates and what is used of its allowances
plans()plans()the plans on sale
billing()billing()balance
ledger({ limit, cursor })ledger(limit, cursor)the balance statement, a page at a time

Webhooks

NodePythonWhat it does
webhooks()webhooks()your endpoint and whether it is disabled (adding or removing one needs the website)
reactivateWebhook(id)reactivate_webhook(id)re-enable a disabled endpoint and resume what it paused
deliveries({ limit, cursor })deliveries(limit, cursor)delivery attempts, newest first
deliveryStats({ hours })delivery_stats(hours)delivery success and latency