What is the endpoint for [P032]Award?

The [P032]Award endpoint is GET https://connect.patsnap.com/advanced-patent-data/award-data.

What data can [P032]Award return?

[P032]Award Receive award data by patent_id or patent_number. This includes award name, level, session, referrer, and type. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [P032]Award?

The OpenAPI schema is available at /openapi.json#/paths/~1advanced-patent-data~1award-data/get. You can also browse the full specification at /openapi.json.

[P032]Award

get

https://connect.patsnap.com/advanced-patent-data/award-data

Try in Sandbox

Receive award data by patent_id or patent_number. This includes award name, level, session, referrer, and type.

The API supports batch requests with a maximum of 100 patents, and more patent id or patent number are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`patent_id`	`string`	`233e60d4-b483-4c38-8fd7-c344d6fd44f3`	patent_id
`patent_number`	`string`	`EP2170021B1`	patent_number

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`pn`	`string`	`US11205304B2`	patent number
`patent_id`	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`patent_award_data`	`array`	`Please check the form: PatentAwardData`	award data
`category`	`string`	`Popular`	Award type
`award_name`	`string`	`European Inventor Award`	Award name, including CN patent awards of several provinces/cities and European Inventor Award
`award_level`	`string`	`优秀奖`	Award level, only CN jurisdiction have this field
`award_session`	`string`	`2018`	Award session
`award_referrer`	`string`	`大连市知识产权局`	Award referrer, only CN jurisdiction have this field
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": [
    {
      "pn": "US11205304B2",
      "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269",
      "patent_award_data": [
        {
          "category": "Popular",
          "award_name": "European Inventor Award",
          "award_level": "优秀奖",
          "award_session": 2018,
          "award_referrer": "大连市知识产权局"
        }
      ]
    }
  ],
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found