- Created by Sebastian Aldén, last modified on Nov 04, 2020
2020-11-04
- Added restriction of short querys. A few words are now needed.
Short query/Language
{
"status"
:
"error"
,
"message"
:
"The input was short and our language detection algorithm not smart enough to understand, please add some more text."
}
2020-10-23
- Added GET Download to API idea v 1.0 as a switch option for data exports.
2019-12-16
GET Index
CHANGED:
Boost index is no longer in beta.
REMOVED:
Header:
Client-id is now removed.
Sample call (cURL) | Version 2.1 | Version 3.0 |
---|---|---|
curl --request GET \ | curl -X GET \ https://api.ipscreener.com/v3/index \ -H 'Authorization: <value>' \ |
POST Search
Sample call (cURL) | Version 2.1 | Version 3.0 |
---|---|---|
curl -X POST \ | curl -X POST \ |
NEW:
HTTPS Status code 422 Unprocessable Entity <Title> | Version 3.0 |
---|---|
Text to short/unsupported language/only numbers | { |
When entering a incorrect format | { |
If space, enter, tab or blank is used | { |
When class input value is incorrect | { |
When whitespace is used as a value in class | { |
REMOVED:
HTTPS Status code 422 Unprocessable Entity <Title> | Version 2.1 |
---|---|
When using invalid client-id | { "status": "error", "message": "No permission granted for this client-id.", "data": null } |
GET Search
Sample call (cURL) | Version 2.1 | Version 3.0 |
---|---|---|
curl -X GET \ | curl -X GET \ |
Success Response | Version 2.1 | Version 3.0 |
---|---|---|
Code example { | Code example { |
REMOVED:
Success Response | Version 2.1 | Version 3.0 |
---|---|---|
applicant (array): This field provides information about the patent owner(s) or applicant(s).
| applicant (array): This field provides information about the patent owner(s) or applicant(s).
| |
inventor (array): This field provides information about the inventor(s).
| inventor (array): This field provides information about the inventor(s).
| |
class (array): The classification scheme is a system of codes that groups inventions according to technical area, where IPC and CPC is the most common. The class information is divided into the follwoing hierarchy, including four sections:
| class (array): The classification scheme is a system of codes that groups inventions according to technical area, where IPC and CPC is the most common. The class information is divided into the follwoing hierarchy, including four sections:
|
GET Stats 3.0
NEW:
URL: https://api.ipscreener.com/v3/stats
Method: GET
Sample call (cURL) | Version 2.1 | Version 3.0 |
---|---|---|
curl -X GET \ https://api.ipscreener.com/v3/stats \ -H 'Authorization: xxx' \ |
Headers: |
---|
required: authorization=[value] |
authorization: An API authorization key must be sent with all requests. You need to contact the IPscreener support team to get the API authorization key. |
Body: |
---|
ticket: The ticket value used to retrieve the results is the ticket session identification data string received by the POST search request. |
Success Response: |
---|
publication years (array):What year the patent was first published. applicants (array):Who made the application. classes (array): Which classes are used in the search. priority country (array): Which country does the most applications. terms (array): The most relevant keywords based on quary. value: The score is the AutoMatch engine indication of the estimated relevance of a document. |
Success Response | Code example |
---|---|
HTTP Status Code: 202 Accepted | Click here to expand... { |
HTTP Status Code: 200 OK | Click here to expand... { |
HTTP Status Code: 204 No Content (When no result could be found) | Click here to expand... <Blank> |
Error Response | Code example |
---|---|
HTTP Status Code: 401 Unauthorized (No API authorization key found) | Click here to expand... { |
HTTP Status Code: 403 Forbidden (Using wrong API authorization key) | Click here to expand... { |
GET PDF 3.0
- No changes
- No labels
Add Comment