POST
https://api.nexscope.ai/zy/patentCitedRun 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/patentCited |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
patentId | string | optional | Patent IDs, multiples separated by English commas, upper limit 100, maximum length 60,000 characters; priority is given when it exists together with `patentNumber`. |
patentNumber | string | optional | Public announcement numbers, multiple ones separated by English commas, the upper limit is 100, and the maximum length is 60,000 characters. |
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 (13 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of records. |
data | array | optional | Patent List. |
columns | array | optional | Rendered column definitions. |
costToken | integer | optional | Consume token. |
type | string | optional | Rendering style. |
patentId | string | optional | Patent ID. |
pn | string | optional | Public (announcement) number. |
citedBy3y | integer | optional | Number of citations in 3 years. |
citedBy5y | integer | optional | Number of citations in 5 years. |
citedBySimpleFamily | integer | optional | Number of patents cited by simple homologous families. |
citedByInpadocFamily | integer | optional | INPADOC Number of cited patents in the same family. |
citedByPatsnapFamily | integer | optional | Nexscope Number of cited patent families. |
citedByPatents | array | optional | List of cited patents. |
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.