API v 3.0

GET Index

CHANGED:

Boost index is no longer in beta.

REMOVED:

Header:

Client-id is now removed.



Sample call (cURL)

Version 2.1Version 3.0

curl --request GET \
 --url https://api.auto-match.se/v2/index \
 --header 'authorization: xxx' \
 --header 'client-id: xxx'

curl -X GET \
  https://api.ipscreener.com/v3/index \
  -H 'Authorization: <value>' \

POST Search



Sample call (cURL)

Version 2.1Version 3.0

curl -X POST \
 --url https://api.auto-match.se/v2.1/search \
 -H 'Authorization: xxx' \
 --header 'client-id: xxx' \
 --header 'reference-number: SE-123' \
 -d 'query=car&index=1&requested-hits=2&view=bibliographic'

curl -X POST \
  https://api.ipscreener.com/v3/search \
  -H 'Authorization: xxx' \
  -d 'query=car&index=1&requested-hits=1&view=bibliographic%2Cclaim%2Cdescription%2Cpdf%2Cpassage%2Cimage&date=2018-01-01&class=G01F11%2F261'

NEW:

HTTPS Status code 422 Unprocessable Entity <Title>Version 3.0
Text to short/unsupported language/only numbers

{
    "status": "error",
    "message": "Can not validate query input language",
    "data": null
}

When entering a incorrect format

{
    "status": "error",
    "message": "The date is not a valid date.",
    "data": null
}

If space, enter, tab or blank is used

{
    "status": "error",
    "message": "date can not only contain white space, new line, tab or empty input",
    "data": null
}

 When class input value is incorrect

{
    "status": "error",
    "message": "Class data is not valid",
    "data": null
}

When whitespace is used as a value in class

{
    "status": "error",
    "message": "class can not only contain new line, tab or empty input",
    "data": null
}

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.1Version 3.0

curl -X GET \
-url https://api.auto-match.se/v2.1/search?ticket=<value> \
-H 'Authorization: xxx' \

curl -X GET \
  'http://api.ipscreener.com/v3/search?ticket=<value>' \
  -H 'Authorization: xxx' \


Success

Response

Version 2.1Version 3.0
 Code example

{
    "status": "success",
    "message": "Resource Fetched Successfully",
    "data": {
        "automatch-results": {
            "<index-x value>": [
                {
                    "relevance": {
                        "score": 514.81525,
                        "position": 1,
                        "country": "US",
                        "number": "4830558",
                        "kind-code": "A",
                        "family-number": 1339803,
                        "publication-date": "1989-05-16"
                    },
                    "bibliographic": {
                        "applicant": [
                            {
                                "country": "US",
                                "name": "THEODORE J SWEENEY & CO"
                            }
                        ],
                        "inventor": [
                            {
                                "country": "US",
                                "name": "SWEENEY THEODORE J"
                            }
                        ],
                        "class": [
                            {
                                "group": "F16B",
                                "main": "F16B21",
                                "sub": "F16B21/07",
                                "type": "IPC"
                            },
                            {
                                "group": "F16B",
                                "main": "F16B5",
                                "sub": "F16B5/00",
                                "type": "IPC"
                            },
                        ],
                        "title": [
                            {
                                "language": "en",
                                "text": "Adhesively securable fastener"
                            }
                        ],
                        "abstract": [
                            {
                                "language": "en",
                                "text": "Described is an adhesively securable fastener comprising a body having an opening; an adhesive positioned within said body and registering with the opening of the chamber, a plunger means for applying pressure to said adhesive such as against an anvil means thereby adhesively securing the fastener to a substrate. Also described is a method for securing a substrate using the fastener described herein."
                            }
                        ]
                    },
                    "claim": {
                        "language": "en",
                        "text": "What is claimed is:\n 1.\n 1. a self-contained adhesively securable fastener for securing an article\n to a substrate wherein there is a body member containing an adhesive\n reservoir with plunger means for expelling adhesive therefrom and wherein\n the body member also has a surrounding surface portion adapted to\n substantially mate with a substrate when the body member is urged there\n against, the invention characterized by:..."
                    },
                    "description": {
                        "language": "en",
                        "text": "BACKGROUND OF THE INVENTION\n The present case is concerned with the fastener art as well as with the art\n of quicksetting adhesives.\n The utilization of quicksetting adhesive has been sharply diminished\n because of the handling problem associated with said adhesive. Mechanical\..."
                    },
                    "passage": {
                        "section": "description",
                        "language": "en",
                        "text": "means for handling quickset adhesives. It is also an object of the\n present invention to mechanically and adhesively secure a fastener to a\n substrate. It is also an object of the present invention to describe a\...
                    },
                    "image": {
                        "data": "<base64 encoded data>"
                    },
                    "pdf": "https://api.auto-match.se/v2/pdf/US-4830558-A"
                }

 Code example

{
    "status": "success",
    "message": "Resource Fetched Successfully",
    "data": {
        "ipscreener-results": {
            "<index-x value>": [
                {
                    "relevance": {
                        "score": 209.0604,
                        "position": 1,
                        "country": "US",
                        "number": "9927975",
                        "kind-code": "B2",
                        "family-number": 61071468,
                        "publication-date": "2018-02-08"
                    },
                    "bibliographic": {
                        "applicant": [
                            {
                                "name": "Micron Technology"
                            },
                            {
                                "name": " Inc."
                            }
                        ],
                       "inventor": [
                            {
                                "name": "Pratt Thomas L."
                            }
                        ],
                        "class": [
                            {
                                "sub": "G06F3/0604",
                                "type": "CPC"
                            },
                            {
                                "sub": "G06F3/0605",
                                "type": "CPC"
                            },
                       "title": [
                            {
                                "language": "en",
                                "text": "Hybrid memory drives, computer system, and related method for operating a   multi-mode hybrid drive"
                            }
                        ],
                        "abstract": [
                            {
                                "language": "en",
                                "text": "A multi-mode hybrid memory drive comprises a bulk memory device and a removable cache memory device. A controller of the bulk memory device may be configured to operate the bulk memory device in either a stand-alone mode or a hybrid mode responsive to detecting the removable cache memory device being coupled with a cache port of the bulk memory device...
                           }
                        ]
                    },
                    "passage": {
                        "section": "description",
                        "language": "en",
                        "text": "at a lower price.\nHybrid drives include features of both the SSDs and HDDs in that traditional magnetic HDD storage media is used for long term storage and solid state Flash-type storage media is used for cache storage. Thus, hybrid drives have become desirable because they deliver higher performance than conventional drives, but at a more reasonable cost...
                   },
                    "claim": [
                        {
                            "language": "en",
                            "text": "1. A hybrid memory drive, comprising:\na bulk memory device including:\nbulk storage media including non-volatile memory;\na cache port; and\na first controller operably coupled with the cache port and the bulk storage media; and\na removable cache memory device including:\ncache storage media including non-volatile memory...
                        }
                    ],
                    "description": [
                        {
                            "language": "en",
                            "text": "TECHNICAL FIELD\nThe disclosure, in various embodiments, relates generally to the field of computer systems and mass storage devices. More specifically, the disclosure relates to mass storage devices configured to operate as either a hybrid drive or a stand-alone drive depending on its mode of operation.\nBACKGROUND\nNon-volatile memory is commonly used for mass storage of data, such as within consumer electronic devices...
                        }
                    ],
                    "image": {
                        "data":<base64 format link>
                   },
                    "pdf": "https://api.ipscreener.com/v3/pdf/US-9927975-B2"
                },

REMOVED:






Success

Response

Version 2.1Version 3.0

applicant (array): This field provides information about the patent owner(s) or applicant(s).

  • country: It is the two-letter country code of the patent owner(s) or applicant(s).
  • name: This field returns the name of the patent owner(s) or applicant(s).

applicant (array): This field provides information about the patent owner(s) or applicant(s).

  • name: This field returns the name of the patent owner(s) or applicant(s).

inventor (array): This field provides information about the inventor(s).

  • country: It is the two-letter country code of the inventor(s).
  • name: This field returns the name of the inventor(s).

inventor (array): This field provides information about the inventor(s).

  • name: This field returns the name of 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:

  • sub-class: This is the class information on group level, e.g. H04M.
  • group: This is the class information on main level e.g. H04M15.
  • sub-group: This is the complete class information e.g. H04M15/03.
  • type: This declares the classification system referred to e.g. IPC, CPC

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:

  • sub: This is the complete class information e.g. H04M15/03.
  • type: This declares the classification system referred to e.g. IPC, CPC



GET Stats 3.0 

NEW:

URL: https://api.ipscreener.com/v3/stats

Method: GET


Sample call (cURL)

Version 2.1Version 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 ResponseCode example
HTTP Status Code: 202 Accepted
 Click here to expand...

{
    "status": "success",
    "message": "Processing",
    "data": null
}

HTTP Status Code: 200 OK 
 Click here to expand...

{
    "status": "success",
    "message": "Resource Fetched Successfully",
    "data": {
        "ipscreener-results": {
            "index-1": {
                "publication_years": [
                    {
                        "publication_year": 1992,
                        "value": 9
                    },
                    {
                        "publication_year": 2013,
                        "value": 5
                    }     
                ],
                "applicants": [
                    {
                        "name": "ROBBINS EDWARD S III",
                        "value": 9
                    },
                    {
                        "name": "LOGIDOS APS",
                        "value": 4
                    }
                ],
                "classes": [
                    {
                        "main": "G01F11",
                        "value": 86
                    },
                    {
                        "main": "B65D83",
                        "value": 22
                    }
                ],
                "priority_country": [
                    {
                        "country": "US",
                        "value": 44
                    },
                    {
                        "country": "CA",
                        "value": 5
                    }
 
                ],
                "terms": [
                    {
                        "name": "ssds",
                        "value": 5.593044
                    },
                    {
                        "name": "cells",
                        "value": 3.1091845
                    }
                ]
            }
        }
    }
}

HTTP Status Code: 204 No Content (When no result could be found)
 Click here to expand...

<Blank>

Error ResponseCode example
HTTP Status Code: 401 Unauthorized (No API authorization key found)
 Click here to expand...

{
    "message": "No API Key is found in request"
}

HTTP Status Code: 403 Forbidden (Using wrong API authorization key)
 Click here to expand...

{
    "message": "Invalid authentication credentials"
}


GET PDF 3.0

  • No changes