|
and Register
Home
Contact Us

Patent Data Search [P002]Analytics Query Search

[P002]Analytics Query SearchPublic
V1
Search PatSnap's global patent database using standard text queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper. This includes patent count, patent number, and patent ID.

Basic Information

Resource URL: /search/patent/query-search-patent

Request Mode: post

Return Format: application/json

The API can only be called after logging in, click to log in

API Description Document Download

Request Parameters

body
QuerySearchRequest
ParameterTypeRequiredDescriptionSample
collapse_bystringfalse

"APD" means order according to application date;

"PBD" means order according to publication date;

"AUTHORITY" means order according to authority;

"SCORE" means order according to the relevance score

PBD
collapse_orderstringfalse
When collapse_type="APNO", and collapse_by="APD" or "PBD", the collapse_order can be set as "OLDEST" or "LATEST", means keep the patent date of oldest or latest one
LATEST
collapse_typestringfalse

"ALL" or Null value means no collapse;

"APNO" means collapse according to application number;

"DOCDB" means collapse according to simple family;

"INPADOC" means collapse according to inpadoc family;

"EXTEND" means collapse according to patsnap family

DOCDB
query_textstringtrue
Analytics query, maximum length 1,500 characters
TACD: virtual reality
sortarrayfalse
Field order, field can support: PBDT_YEARMONTHDAY, APD_YEARMONTHDAY, ISD,SCORE; order can support: desc, asc.
[ { "field": "PBDT_YEARMONTHDAY", "order": "DESC" } ]
offsetintegerfalse
offset value; limit + offset <= 20000 (the max number of Semantic Search is 1000)
0
limitintegerfalse
limit of returned response; must be <= 1,000
10

Request Sample

  • Curl
  • NodeJs
  • Python
  • Java
curl -X POST "https://connect.zhihuiya.com/search/patent/query-search-patent?apikey="
-H "Content-Type:application/json"
-H "authorization:Bearer {token}"
-d '{"sort":[{"field":"PBDT_YEARMONTHDAY","order":"DESC"}],"limit":10,"offset":0,"query_text":"TACD: virtual reality","collapse_by":"PBD","collapse_type":"DOCDB","collapse_order":"LATEST"}'
const axios = require('axios');
const options = {
    url: "https://connect.zhihuiya.com/search/patent/query-search-patent",
    method: "POST",
    headers: {
        'Content-Type': 'application/json',
        'authorization': 'Bearer {token}',
    },
    params: {
        'apikey': '',
    },
    data: {
        "sort": [
            {
                "field": "PBDT_YEARMONTHDAY",
                "order": "DESC"
            }
        ],
        "limit": 10,
        "offset": 0,
        "query_text": "TACD: virtual reality",
        "collapse_by": "PBD",
        "collapse_type": "DOCDB",
        "collapse_order": "LATEST"
    }
};
axios(options).then(res => {
    console.log(res.data)
}).catch(err => {
    console.log(err)
})
import requests
url = "https://connect.zhihuiya.com/search/patent/query-search-patent"

params = {
    "apikey": ""
}

payload = {
    "sort": [
        {
            "field": "PBDT_YEARMONTHDAY",
            "order": "DESC"
        }
    ],
    "limit": 10,
    "offset": 0,
    "query_text": "TACD: virtual reality",
    "collapse_by": "PBD",
    "collapse_type": "DOCDB",
    "collapse_order": "LATEST"
}

headers = {
    "Content-Type": "application/json",
    "authorization": "Bearer {token}"
}

response = requests.request("POST", url, params=params, json=payload, headers=headers)

print(response.text)
public static void main(String[] args) {
    String host = "https://connect.zhihuiya.com";
    String path = "/search/patent/query-search-patent";

    Map headers = new HashMap();
    headers.put("Content-Type", "application/json");
    headers.put("authorization", "Bearer {token}");

    Map querys = new HashMap();
    querys.put("apikey", "");
    JSONObject dataBody = (JSONObject)JSON.parse("{\"sort\":[{\"field\":\"PBDT_YEARMONTHDAY\",\"order\":\"DESC\"}],\"limit\":10,\"offset\":0,\"query_text\":\"TACD: virtual reality\",\"collapse_by\":\"PBD\",\"collapse_type\":\"DOCDB\",\"collapse_order\":\"LATEST\"}");

    try {
        /**
        * Important Tips:
        * Please Download HttpUtils From
        * https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/src/main/java/com/aliyun/api/gateway/demo/util/HttpUtils.java
        *
        * Please refer to the corresponding dependence:
        * https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/pom.xml
        */
        HttpResponse response = HttpUtils.doPost(host, path, null, headers, querys, dataBody.toJSONString());
        System.out.println(EntityUtils.toString(response.getEntity()));
    } catch (Exception e) {
        e.printStackTrace();
    }
}
Copy

Response Parameters

CommonResponse
ParameterTypeRequiredDescriptionSample
data
objectfalse
response data
no sample
status
booleantrue
Status
false
error_msg
stringfalse
Error Message
The request parameter format is incorrect!
error_code
integertrue
Error Code
0
SearchPatentResponse
ParameterTypeRequiredDescriptionSample
results
arrayfalse
result
Please check the form: PatentBaseResponse
result_count
integerfalse
Received result count
10
total_search_result_count
integerfalse
Total search result count
1000
PatentBaseResponse
ParameterTypeRequiredDescriptionSample
pn
stringfalse
patent number
US11205304B2
patent_id
stringfalse
patent id
718ead9c-4f3c-4674-8f5a-24e126827269

Response Error Details

error_codeDescription
0Success
201Created
401Unauthorized
403Forbidden
404Not Found
68300004Invalid parameter!
68300005Search api failure!
68300006Analytic basic access error!
68300007Bad request!
68300008Service error, please try again later!
68300010The file does not comply with upload specifications!
67200001API call exceeds the total limit set by the platform!
67200002Quota exceeds the limit!
67200003Access token expired or authentication error!
67200004No permission or API package quota has exceeded the limit!
67200005Insufficient balance, call failed!
67200006This client has expired and call failed!
67200007Exceeded the call limit, call failed!

Response Body

  • json
{
    "data": {
        "results": [
            {
                "pn": "US11205304B2",
                "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269"
            }
        ],
        "result_count": 10,
        "total_search_result_count": 1000
    },
    "status": true,
    "error_code": 0
}
Copy
[P003]Analytics Query Search and Filter