This is a technical documentation that describes the IPscreener API's interaction with the AutoMatch search engine.
\nThe specification is intended for those who are experienced in programming software applications and intend to implement the IPscreener API service.
\nThis documentation is subject to continuous change, however normally backward compatibility is maintained.
\nUX API: is for pulling data and using our interface. (You need to have an account in IPscreener platform)
\nDATA API: is for pulling raw data and configure your own interface.
\n\n\nOur documentation link: https://docs.ipscreener.com/
\n
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15087018","collectionId":"54ca0f67-78bc-40c7-939e-d7e5a1b7e0fa","publishedId":"2s9YJc23Kb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-24T10:29:53.000Z"},"item":[{"name":"IPscreener API","item":[{"name":"Data API","item":[{"name":"case","id":"e62ea9db-8d74-468e-8471-129fe428cba6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{ key }}","description":"For any support contact us directly on: support@ipscreener.com
\n
Authorization key you get from admin
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"tester@ipscreener.com","type":"text","description":"Required
\n"},{"key":"reference","value":"Project1334A","type":"text","description":"Required
\n"},{"key":"title","value":"Abstract of Disclosure method","type":"text","description":"Required
\n"},{"key":"summary","value":"The system may also enable a number of users to share space on a custom probe array. Another optional feature is to enable a number of users to share in ordering portions of a lot of catalog probe arrays to take advantage of economies of scale from lot-size purchases","type":"text","description":"Required
\n"},{"key":"patent_number","value":"US2010200401","type":"text","disabled":true},{"key":"class","value":"G06Q30/06,H05G2/008","type":"text","disabled":true},{"key":"publication_date","value":"2024-01-01/2031-01-02","type":"text","disabled":true},{"key":"priority_date","value":"2022-01-01/2024-01-02","type":"text","disabled":true},{"key":"applicant","value":"IBM, Nestle","type":"text","disabled":true},{"key":"inventor","value":"ZHOU XUE MEI,SMITH DAVID P,SIANI-ROSE MICHAEL A","type":"text","disabled":true},{"key":"rows","value":"1","type":"text","disabled":true},{"key":"keyword","value":"Abstract OR Disclosure","type":"text","disabled":true},{"key":"batch","value":"US2010200401,US2019266649","type":"text","disabled":true}]},"url":"https://my.ipscreener.com/api/data/case","description":"This API receives a text query input and then uses the AutoMatch semantic search engine to retrieve similar results from the worldwide patent database collection. The search procedure includes a first response to a query by returning a session ticket, which then is used to retrieve the results when ready for retrieval. Processing an IPscreeener query typically takes 15-30 seconds, and the patent data is delivered in a JSON format. The number of records delivered depends on the figure specified by the requested-hits parameter and are presented in order of ranked relevance. If the requested-hits parameter is null or absent, 25 records are returned by default. The request procedure is optimized for returning up to 100 records.
\nIf no switches are provided IPscreener will select the most appropriate general settings for carrying out the semantic matching procedure, and returns a single result list. If the query specifies several indexes to be queried in the request, the number of results set by the requested-hits parameter applies to all. Thus, this is the number retrieved for each and one of the queried indexes, where the results for each index are presented sequentially according to the request order in the query string.
\n","urlObject":{"protocol":"https","path":["api","data","case"],"host":["my","ipscreener","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e62ea9db-8d74-468e-8471-129fe428cba6"},{"name":"case","id":"805a8016-dbe2-4cb9-93d9-2e88bdf0a04d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{key}}","type":"text"}],"url":"https://my.ipscreener.com/api/data/case/?token={{ token }}&family=true","urlObject":{"protocol":"https","path":["api","data","case",""],"host":["my","ipscreener","com"],"query":[{"key":"token","value":"{{ token }}"},{"key":"family","value":"true"}],"variable":[]}},"response":[],"_postman_id":"805a8016-dbe2-4cb9-93d9-2e88bdf0a04d"},{"name":"stats","id":"1b9f68ff-6081-4e14-8f0f-cc0be9e0d3ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/data/stats/{{token}}","urlObject":{"protocol":"https","path":["api","data","stats","{{token}}"],"host":["my","ipscreener","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b9f68ff-6081-4e14-8f0f-cc0be9e0d3ea"},{"name":"pdf","id":"00bc408f-3ace-4b7e-a693-4f18e5af6d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/data/pdf/US-2019266649-A1","description":"The PDF API is used to retrieve the original patent document(s) corresponding to a search query. From the requested patent number input via an URL query, the API request returns a PDF file in base64 format.
\n","urlObject":{"protocol":"https","path":["api","data","pdf","US-2019266649-A1"],"host":["my","ipscreener","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"00bc408f-3ace-4b7e-a693-4f18e5af6d91"}],"id":"55119538-585d-403c-82c8-2b4d5b229af8","description":"API for pulling raw data and configure your own interface.
\n","_postman_id":"55119538-585d-403c-82c8-2b4d5b229af8"},{"name":"UX API","item":[{"name":"case","id":"8eeafbb2-f2b7-4216-a106-22e9fce1ab82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"test@ipscreener.com","type":"text","description":"User's email
\n"},{"key":"reference","value":"Project 12A","type":"text","description":"Case reference
\n"},{"key":"title","value":"Toothbrush with toothpaste in the shaft","type":"text","description":"Case title
\n"},{"key":"summary","value":"A toothbrush that also has a container of toothpaste in the shaft. optionally, you can attach or attach a tube of toothpaste to the toothbrush. then all you have to do is press or squeeze the brush shaft to get toothpaste at the brush edges and add toothpaste while using the brush. ","type":"text","description":"Summary text here
\n"},{"key":"patent_number","value":"US2010200401","type":"text","description":"Functions to have access to in the idea: \"share,watch,export\"
\n","disabled":true},{"key":"class","value":"","type":"text","description":"If we require auth before seeing the result
\n","disabled":true},{"key":"publication_date","value":"2024-01-01/2031-01-02","type":"text","description":"A list of email addresses that are allowed to access the case
\n","disabled":true},{"key":"priority_date","value":"2024-01-01/2031-01-02","type":"text","disabled":true},{"key":"applicant","value":"","type":"text","disabled":true},{"key":"inventor","value":"","type":"text","disabled":true},{"key":"keyword","value":"","type":"text","disabled":true},{"key":"batch","value":"","type":"text","disabled":true},{"key":"access","value":"share,export","type":"text","disabled":true},{"key":"auth","value":"true","type":"text","disabled":true},{"key":"shared_with","value":"test2@ipscreener.com","type":"text","disabled":true},{"key":"version_parent","value":"","description":"case id of parent
\n","type":"text","uuid":"5633ad4b-f6bd-4406-a1bd-b83fd9533b62"}]},"url":"https://my.ipscreener.com/api/ux/case","description":"Note: you can't have parameter \"summary\" and \"patent_number\" in the same search request, you need to choose only 1.
\n","urlObject":{"protocol":"https","path":["api","ux","case"],"host":["my","ipscreener","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8eeafbb2-f2b7-4216-a106-22e9fce1ab82"},{"name":"case","id":"fa621a60-99c6-4873-8951-021628f9cbac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/ux/case/?case={{case}}&view=all&rank&family","urlObject":{"protocol":"https","path":["api","ux","case",""],"host":["my","ipscreener","com"],"query":[{"key":"case","value":"{{case}}"},{"description":{"content":"ranked,all
\n","type":"text/plain"},"key":"view","value":"all"},{"key":"rank","value":null},{"key":"family","value":null}],"variable":[]}},"response":[],"_postman_id":"fa621a60-99c6-4873-8951-021628f9cbac"},{"name":"version","id":"ed7b358c-b799-47c1-9206-8b3cca06a731","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/ux/version/?case={{case}}","urlObject":{"protocol":"https","path":["api","ux","version",""],"host":["my","ipscreener","com"],"query":[{"key":"case","value":"{{case}}"}],"variable":[]}},"response":[],"_postman_id":"ed7b358c-b799-47c1-9206-8b3cca06a731"},{"name":"case","id":"157e8f6e-b972-4912-95a5-339eebbc8fae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/ux/case/{{token}}?expire=&shared_with=","urlObject":{"protocol":"https","path":["api","ux","case","{{token}}"],"host":["my","ipscreener","com"],"query":[{"key":"expire","value":""},{"key":"shared_with","value":""}],"variable":[]}},"response":[],"_postman_id":"157e8f6e-b972-4912-95a5-339eebbc8fae"},{"name":"stats","id":"4c6bee82-bbea-4171-be48-3e006a01d95c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/ux/stats/{{case}}","urlObject":{"protocol":"https","path":["api","ux","stats","{{case}}"],"host":["my","ipscreener","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c6bee82-bbea-4171-be48-3e006a01d95c"},{"name":"pdf","id":"b91dd474-c09c-48a4-9428-f6c45d3b20db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{ key }}","description":"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/ux/pdf/US-2019266649-A1","description":"The PDF API is used to retrieve the original patent document(s) corresponding to a search query. From the requested patent number input via an URL query, the API request returns a PDF file in base64 format.
\n","urlObject":{"protocol":"https","path":["api","ux","pdf","US-2019266649-A1"],"host":["my","ipscreener","com"],"query":[],"variable":[]}},"response":[{"id":"3b216420-9990-4ef5-b1ec-71b83d71bd62","name":"pdf","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"3HddbuvnfZbG2I7"}],"url":"https://beta.ipscreener.com/api/ux/pdf/US-2019266649-A1"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.29.0"},{"key":"Date","value":"Mon, 11 Aug 2025 08:46:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"PHPSESSID=mltdl2shp5jse218f9bpbndq7l; path=/"},{"key":"Set-Cookie","value":"PHPSESSID=mltdl2shp5jse218f9bpbndq7l; path=/; secure; HttpOnly"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Resource Fetched Successfully\",\n \"data\": \"Authorization key you get from admin
\n","type":"text"}],"url":"https://my.ipscreener.com/api/ux/download/?case={{ case }}&type=pdf_ranked&url=true","urlObject":{"protocol":"https","path":["api","ux","download",""],"host":["my","ipscreener","com"],"query":[{"key":"case","value":"{{ case }}"},{"description":{"content":"Possible options: pdf_ranked, pdf_all, excel_ranked, excel_all, word_ranked, ids
\n","type":"text/plain"},"key":"type","value":"pdf_ranked"},{"key":"url","value":"true"}],"variable":[]}},"response":[],"_postman_id":"c4ae7f36-b507-44e0-bbfb-1f7dc177ec61"}],"id":"fcd8bf21-8b5c-46ec-ab3e-e52219e9f81a","description":"API for pulling data and using IPscreener platform/interface.
\n","_postman_id":"fcd8bf21-8b5c-46ec-ab3e-e52219e9f81a"}],"id":"60dcaaee-99c9-49d6-ad30-897f05b52b70","description":"The IPscreener API is a tool that enables developers to integrate IPscreener's patent analysis capabilities into their own applications or platforms. By utilizing this API, users can programmatically access IPscreener's features, such as analyzing patent information, extracting relevant business intelligence, and generating reports, all within their own systems. This integration streamlines the innovation process by providing seamless access to patent data and insights directly through the API.
\n","_postman_id":"60dcaaee-99c9-49d6-ad30-897f05b52b70"}]}