What is the endpoint for [P007]Patent Number Search Similar Patent?

The [P007]Patent Number Search Similar Patent endpoint is POST https://connect.patsnap.com/search/patent/similar-search-patent.

Where can I find the OpenAPI schema for [P007]Patent Number Search Similar Patent?

The OpenAPI schema is available at /openapi.json#/paths/~1search~1patent~1similar-search-patent/post. You can also browse the full specification at /openapi.json.

[P007]Patent Number Search Similar Patent

Q: What data can [P007]Patent Number Search Similar Patent return?

[P007]Patent Number Search Similar Patent Receive similar patent list by patent id or patent number search, patent id is preferred when both are requested, the maximum number of patents returned is 1000. Sort by default from high to low similarity score. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/search/patent/similar-search-patent

Try in Sandbox

Receive similar patent list by patent id or patent number search, patent id is preferred when both are requested, the maximum number of patents returned is 1000. Sort by default from high to low similarity score.

1.This API is suitable for similar patent searches of invention patents and utility model patents; 2.If similar patent searches for design patents are required, it is recommended to use the P060/P061 APIs.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`apd_from`	`string`	`20200101`	Start year of application date
`apd_to`	`string`	`20220101`	End year of application date
`country`	`array`	`[ "CNA", "CNB" ]`	Authority and kind code. For the Authority code, refer to https://analytics.patsnap.com/status; Kind code is: A (Application), B (Granted Patent), U (Utility Model), D (Design). Multiple items can be searched, separated by comma.
`patent_id`	`string`	`b053642f-3108-4ea9-b629-420b0ab959e3`	Patent id
`patent_number`	`string`	`CN106185468A`	Patent number
`pbd_from`	`string`	`20200101`	Start year of publication date
`pbd_to`	`string`	`20220101`	End year of publication date
`relevancy`	`string`	`50%`	relevancy (the relevancy calculated logic can refer to: https://help.patsnap.com/hc/en-us/articles/210698769-What-Is-Semantic-Search-How-Does-It-Work)
`offset`	`integer<int32>`	-	offset value; limit + offset <= 20000 (the max number of Semantic Search is 1000)
`limit`	`integer<int32>`	`10`	limit of returned response; must be <= 1,000

{
  "limit": 10,
  "apd_to": 20220101,
  "offset": 0,
  "pbd_to": 20220101,
  "country": [
    "CNA",
    "CNB"
  ],
  "apd_from": 20200101,
  "pbd_from": 20200101,
  "patent_id": "b053642f-3108-4ea9-b629-420b0ab959e3",
  "relevancy": "50%",
  "patent_number": "CN106185468A"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`results`	`array`	`Please check the form: SemanticResult`	result
`pn`	`string`	`JP1999068462A`	patent number
`apdt`	`integer<int32>`	`20211108`	Application Date
`apno`	`string`	`US17/521392`	Application Number
`pbdt`	`integer<int32>`	`20230815`	Publication Date
`title`	`string`	`Techniques for using multiple symbols to provide feedback for a sidelink transmission`	Title
`inventor`	`string`	`ELSHAFIE, AHMED \| YANG, WEI \| HOSSEINI, SEYEDKIANOUSH`	Inventor
`patent_id`	`string`	`1a47a70d-6b54-4709-a72a-ed552781fcac`	patent id
`relevancy`	`string`	`99%`	relevancy between the result patent and the input content
`current_assignee`	`string`	`QUALCOMM INCORPORATED`	Current Assignee
`original_assignee`	`string`	`QUALCOMM INCORPORATED`	Original Assignee (Applicant)
`current_assignee_address`	`string`	`QUALCOMM INCORPORATED`	Current Assignee Address
`original_assignee_address`	`string`	`QUALCOMM INCORPORATED`	Original Assignee (Applicant) Address
`result_count`	`integer<int32>`	`10`	Received result count
`total_search_result_count`	`integer<int64>`	`1000`	Total search result 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": {
    "results": [
      {
        "pn": "JP1999068462A",
        "apdt": 20211108,
        "apno": "US17/521392",
        "pbdt": 20230815,
        "title": "Techniques for using multiple symbols to provide feedback for a sidelink transmission",
        "inventor": "ELSHAFIE, AHMED | YANG, WEI | HOSSEINI, SEYEDKIANOUSH",
        "patent_id": "1a47a70d-6b54-4709-a72a-ed552781fcac",
        "relevancy": "99%",
        "current_assignee": "QUALCOMM INCORPORATED",
        "original_assignee": "QUALCOMM INCORPORATED",
        "current_assignee_address": "QUALCOMM INCORPORATED",
        "original_assignee_address": "QUALCOMM INCORPORATED"
      }
    ],
    "result_count": 10,
    "total_search_result_count": 1000
  },
  "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
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

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