Docs
Open Revolution St
Guide

Quickstart

Create an API key and make your first request.

1. Create an API key

In Revolution St, open Configuration → API Access and click New API key. Choose a scope (Read only is enough to start) and copy the key. It is shown only once.

Keys start with wxs_pk_. Each key belongs to one environment (production or sandbox), so requests don’t need an environment parameter.

2. Make a request

Send the key as a bearer token. The API base URL is https://v3.revolutionstreetwxs.io/api/v3. If your Revolution St installation has a different address, enter it under Server at the top of the left column and the samples on these pages will use it.

curl https://v3.revolutionstreetwxs.io/api/v3/orders?limit=5 \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

List endpoints are paged with limit and offset and return the rows and a total count. Responses are JSON. Timestamps are ISO 8601 in UTC.

3. Next steps

  • The REST API reference lists every endpoint with its parameters, request and response fields, and examples in cURL, JavaScript and Python.
  • To send requests from a browser, open https://v3.revolutionstreetwxs.io/api/v3/docs and authorize it with your API key.
  • If you use an AI coding tool, connect it to the MCP server so it can look up endpoints while it writes code.
  • The OpenAPI document is at https://v3.revolutionstreetwxs.io/api/v3/openapi.json (download), for code generators and API clients.
esc