Proxy-seller

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

ps_docs_search

馃煝聽read

Search the API docs and return short snippets.

ps_docs_get

馃煝聽read

Read one documentation page or a single section of it.

ps_api_list_endpoints

馃煝聽read

List API operations with method, path and summary.

ps_api_get_endpoint

馃煝聽read

Full details for one operation: parameters, request body, response, errors, examples, available SDK languages.

ps_sdk_snippet

馃煝聽read

A ready-to-use code example for an operation.

ps_whats_new

馃煝聽read

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

query required

string

Free text, an operation_id, or an API path

kind

guide | reference | sdk | errors

Limit to one doc type

tags

string[]

Only docs having all these tags

limit

integer

Max results, default 5

ps_docs_get

馃煝聽read-only 路 docs:read

Read one documentation page or a single section of it.

Parameter

Type

Description

id required

string

Document id, e.g. guides/getting-started

section

string

A ## section title to return only that section

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

tag

string

e.g. order, balance

query

string

Substring over operation id, title, path

method

GET | POST | PUT | PATCH | DELETE

HTTP method

include_deprecated

boolean

Default false

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

operation_id required

string

e.g. createOrder

ps_sdk_snippet

馃煝聽read-only 路 docs:read

A ready-to-use code example for an operation.

Parameter

Type

Description

operation_id required

string

e.g. createOrder

lang required

python | node | php | go | java

SDK language

ps_whats_new

馃煝聽read-only 路 docs:read

Recent documentation versions and what each added, changed or removed. Newest first.

Parameter

Type

Description

since_corpus_sha

string

Only versions newer than this one

since_date

string (ISO 8601)

Only versions after this date

Next steps

On this page