POST
https://api.nexscope.ai/zy/querySearchPatentRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/zy/querySearchPatent |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
queryText | string | required | Analytics search query, up to 12,000 characters, supports field prefixes such as `TACD:`, `TAC:`, `TA:` and `AND`/`OR`/`NOT` Boolean operations. |
limit | integer | optional | Returns the number of patents, range 1–1000. Example: 10 |
offset | integer | optional | Offset, range 0–19,999; `limit + offset` cannot exceed 20,000. Example: 0 |
sort | array | optional | Array of sorting conditions, each element is `{field, order}`; `field`: `PBDT_YEARMONTHDAY`, `APD_YEARMONTHDAY`, `ISD`, `SCORE`; `order`: `DESC` or `ASC`. |
stemming | integer | optional | Whether to enable truncation search: `1` is on, `0` is off. Example: 0 |
collapseType | string | optional | Deduplication methods: `ALL`, `APNO`, `DOCDB`, `INPADOC`, `EXTEND`. Example: ALL |
collapseBy | string | optional | Deduplication sorting fields: `APD`, `PBD`, `AUTHORITY`, `SCORE`. |
collapseOrder | string | optional | Deduplication sort order: `OLDEST` or `LATEST`. |
collapseOrderAuthority | array | optional | Array of receiving office priority, only valid when `collapseBy=AUTHORITY`. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (18 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status, `200` indicates success. |
errmsg | string | optional | Success is `ok`, failure is error description. |
total | integer | optional | The number of results returned this time. |
data | array | optional | Patent List. |
columns | array | optional | Renders column meta information, not data records. |
type | string | optional | Rendering style. |
costToken | integer | optional | Consume token. |
allRecordsCount | integer | optional | Retrieve the total number of hits. |
patentId | string | optional | ZY patent ID. |
pn | string | optional | Public (announcement) number. |
title | string | optional | Patent title. |
apdt | integer | optional | Application date (YYYYMMDD). |
pbdt | integer | optional | Open day (YYYYMMDD). |
apno | string | optional | Application number. |
authority | string | optional | Receiving Office, such as `US`. |
inventor | string | optional | Inventor, multiple people separated by `\|`. |
originalAssignee | string | optional | Original applicant, multiple separated by `\|`. |
currentAssignee | string | optional | Current applicant, multiple separated by `\|`. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.