REST API

The Proceeds REST API lets you manage your services and paywalls programmatically, and read your transactions and events. It’s organized around REST: resource-oriented URLs, JSON request and response bodies, and standard HTTP status codes. This is the management API. It is distinct from the payment URLs your paywalls expose to buyers — see the callout below.

Base URL

https://api.myproceeds.xyz

All endpoints live under the /v1 path, for example GET /v1/services.

Authentication

Every endpoint except the unauthenticated health check requires an API key generated from your dashboard, sent as a header. See Authentication for key format, header options, and scopes.

Response envelope

Successful responses wrap the result in a data field alongside a meta object:

{
  "data": { },
  "meta": {
    "requestId": "req_...",
    "timestamp": "2026-01-01T00:00:00.000Z"
  }
}

List endpoints add pagination to meta:

{
  "data": [ ],
  "meta": {
    "requestId": "req_...",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": { "total": 42, "limit": 20, "offset": 0, "hasMore": true }
  }
}

Conventions

Topic	Behavior
Pagination	List endpoints accept `limit` (1–100, default 20) and `offset` (default 0). Check `meta.pagination.hasMore` to page.
Secret masking	Service `authConfig` values and paywall custom header values are always returned as `"***"`. Field names are visible; plaintext is never exposed. See Authentication.
Request IDs	Every response includes `meta.requestId`. Quote it when contacting support.
Errors	Failures return a structured error body with a machine-readable `code`. See Errors & rate limits.

The REST API documents management endpoints under api.myproceeds.xyz. The payment URLs your buyers call (myproceeds.xyz/api/x402/pay/... and /api/mpp/pay/...) follow the x402 and MPP standards instead — see Payment URLs.

Getting Started

Guides

Manage

API Reference

Agent Wallets

Base URL

Authentication

Response envelope

Conventions

Next steps

Authentication

Errors & rate limits

​Base URL

​Authentication

​Response envelope

​Conventions

​Next steps

Authentication

Errors & rate limits

Base URL

Authentication

Response envelope

Conventions

Next steps