API reference / Watchlists

Send a test delivery

Written and maintained by The ProspectAPIs team

POST/v1/watchlists/:id/test

POST /v1/watchlists/:id/test is the ProspectAPIs operation testWatchlist, in the Watchlists group of the REST API. Send a signed sample funding_event.matched event (with test: true) to the watchlist's webhook now, so the receiver can be built and verified. Free. At most 5 a minute per account. Cost: free, 5 a minute per account. Send your API key as a Bearer token in the Authorization header.

How this fits with the rest of the watchlists API, with worked examples, is in the watchlists guide.

Parameters

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

The outcome of the test delivery. The body is a WatchlistTestResult.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl -X POST https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/test \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/test", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/test",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

This call is free: it never spends credits or free records, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.

Related

The watchlists guide covers this area end to end. Previous operation: Delete a watchlist. Next operation: List recent deliveries. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).