What is the endpoint for [P038]Market Indicators?

The [P038]Market Indicators endpoint is GET https://connect.patsnap.com/patent-valuation-data/market_indicators.

Where can I find the OpenAPI schema for [P038]Market Indicators?

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

[P038]Market Indicators

Q: What data can [P038]Market Indicators return?

[P038]Market Indicators Receive patent market valuation score data by patent_id or patent_number. This includes patent type, family size, family authority count, patent cites count, examiner cites count, and reference cites count. See the Response Schema and Success Response Example on this page for the full structure.

get

https://connect.patsnap.com/patent-valuation-data/market_indicators

Try in Sandbox

Receive patent market valuation score data by patent_id or patent_number. This includes patent type, family size, family authority count, patent cites count, examiner cites count, and reference cites count.

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`	`c3efa1e6-a2c3-4502-b5e7-97fcf570cfd3`	patent_id
`patent_number`	`string`	`US5012236A`	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
`patsnap_market_value`	`object`	`Please check the form: MarketValue`	market indicators
`cites_no`	`integer<int32>`	`5`	Patent cites count
`family_size`	`integer<int32>`	`2`	Family size
`patent_type`	`string`	`PATENT`	Patent type: APPLICATION,PATENT,UTILITY,DESIGN
`reference_no`	`integer<int32>`	`1`	Reference cites count
`examiner_cites_no`	`integer<int32>`	`3`	Patent examiner cites count
`family_covered_country_no`	`integer<int32>`	`1`	Family covered authority count
`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",
      "patsnap_market_value": {
        "cites_no": 5,
        "family_size": 2,
        "patent_type": "PATENT",
        "reference_no": 1,
        "examiner_cites_no": 3,
        "family_covered_country_no": 1
      }
    }
  ],
  "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