Documentation
Updated:
These tools read the bundled Proxy-Seller API documentation. They never touch your account and work without a Client API key.
Permissions: docs:read
What is covered. These tools answer from a snapshot of the Client API v2 documentation, in English: a reference page for every published operation, the guides, and SDK snippets for Python, Node.js, PHP, Go and Java. The snapshot catches up a few minutes after the documentation itself changes.
In this group
Tool | What it does | |
|---|---|---|
馃煝聽 | Search the API docs and return short snippets. | |
馃煝聽 | Read one documentation page or a single section of it. | |
馃煝聽 | List API operations with method, path and summary. | |
馃煝聽 | Full details for one operation: parameters, request body, response, errors, examples, available SDK languages. | |
馃煝聽 | A ready-to-use code example for an operation. | |
馃煝聽 | Recent documentation versions and what each added, changed or removed. |
ps_docs_search
馃煝聽read-only 路 docs:read
Search the API docs and return short snippets.
Parameter | Type | Description |
|---|---|---|
| string | Free text, an |
|
| Limit to one doc type |
| string[] | Only docs having all these tags |
| integer | Max results, default |
ps_docs_get
馃煝聽read-only 路 docs:read
Read one documentation page or a single section of it.
Parameter | Type | Description |
|---|---|---|
| string | Document id, e.g. |
| string | A |
ps_api_list_endpoints
馃煝聽read-only 路 docs:read
List API operations with method, path and summary. Deprecated ones are hidden by default.
Parameter | Type | Description |
|---|---|---|
| string | e.g. |
| string | Substring over operation id, title, path |
|
| HTTP method |
| boolean | Default |
ps_api_get_endpoint
馃煝聽read-only 路 docs:read
Full details for one operation: parameters, request body, response, errors, examples, available SDK languages. Deprecated operations include the name of the replacement.
Parameter | Type | Description |
|---|---|---|
| string | e.g. |
ps_sdk_snippet
馃煝聽read-only 路 docs:read
A ready-to-use code example for an operation.
Parameter | Type | Description |
|---|---|---|
| string | e.g. |
|
| SDK language |
ps_whats_new
馃煝聽read-only 路 docs:read
Recent documentation versions and what each added, changed or removed. Newest first.
Parameter | Type | Description |
|---|---|---|
| string | Only versions newer than this one |
| string (ISO 8601) | Only versions after this date |