{"ok":true,"site":"inspirehep","host":"inspirehep.net","about":"INSPIRE-HEP is the high-energy physics literature database. This CLI searches and fetches papers, citations, references, BibTeX/LaTeX exports, authors, jobs, conferences, seminars, institutions and experiments through INSPIRE's public JSON API.","commands":[{"command":"search-literature","summary":"Search HEP papers with INSPIRE query syntax, with optional filters for document type, date range, author count and subject, plus sorting and paging","params":[{"name":"q","type":"string","required":true,"description":"INSPIRE search query: free text ('dark matter'), 'a G.Bertone.1' (author identifier), 't higgs' (title), 'refersto:recid:648746' (papers citing a record), 'affid 902725' (institution), 'accelerator_ex"},{"name":"sort","type":"string","description":"Sort order","oneOf":["mostrecent","mostcited"],"default":"mostrecent"},{"name":"doc_type","type":"string","description":"Document type facet value, e.g. article, published, review, conference paper, thesis, book, proceedings, lectures, note, report"},{"name":"earliest_date","type":"string","description":"Year range 'YYYY--YYYY'"},{"name":"author_count","type":"string","description":"Number-of-authors facet value, e.g. 'Single author' or '10 authors or less'"},{"name":"subject","type":"string","description":"Subject facet value, e.g. Astrophysics, Phenomenology-HEP, Theory-HEP, Experiment-HEP"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number, starting at 1","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-literature?q=dark+matter&sort=mostcited&doc_type=review&earliest_date=2020--2026&author_count=10+authors+or+less&subject=Astrophysics"},{"command":"list-citing-papers","summary":"List the papers that cite a given literature record (by recid)","params":[{"name":"recid","type":"string","required":true,"description":"Literature record id (control number) of the cited paper"},{"name":"sort","type":"string","description":"Sort order","oneOf":["mostrecent","mostcited"],"default":"mostrecent"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number, starting at 1","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/list-citing-papers?page=2"},{"command":"get-literature-facets","summary":"Get facet counts and aggregations for a literature query: doc types, subjects, authors, collaborations, citations-by-year, citation summary","params":[{"name":"q","type":"string","description":"INSPIRE search query, e.g. 'dark matter' or 'recid:648746'"},{"name":"facet_name","type":"string","description":"Special facet set to compute. Omit for the standard search facets.","oneOf":["citations-by-year","citation-summary","hep-author-publication"]},{"name":"search_type","type":"string","description":"Set to hep-author-publication together with author to get facets for one author's papers","oneOf":["hep-author-publication"]},{"name":"author","type":"string","description":"Author facet key 'RECID_Full Name' (facet_author_name from get-author)"},{"name":"doc_type","type":"string","description":"Document type filter, e.g. review, article, published"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-literature-facets?q=recid%3A648746&facet_name=citations-by-year&author=1019524_Gianfranco+Bertone"},{"command":"get-literature","summary":"Get full metadata for one paper: title, authors, abstract, DOIs, arXiv id, publication info, citation counts","params":[{"name":"id","type":"string","required":true,"description":"Literature record id (control number)"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-literature"},{"command":"list-literature-authors","summary":"List all authors of a paper with their affiliations and INSPIRE author ids","params":[{"name":"id","type":"string","required":true,"description":"Literature record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/list-literature-authors"},{"command":"list-literature-references","summary":"List the references cited by a paper, paginated","params":[{"name":"id","type":"string","required":true,"description":"Literature record id"},{"name":"size","type":"number","description":"References per page","default":25},{"name":"page","type":"number","description":"Page number, starting at 1","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/list-literature-references"},{"command":"export-literature","summary":"Export one paper's citation as BibTeX, LaTeX (EU/US) or CV text","params":[{"name":"id","type":"string","required":true,"description":"Literature record id"},{"name":"format","type":"string","description":"Export format","oneOf":["bibtex","latex-eu","latex-us","cv"],"default":"bibtex"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/export-literature?format=bibtex"},{"command":"export-literature-search","summary":"Bulk-export every paper matching a query as BibTeX or LaTeX ('cite all')","params":[{"name":"q","type":"string","required":true,"description":"INSPIRE search query"},{"name":"format","type":"string","description":"Export format","oneOf":["bibtex","latex-eu","latex-us","cv"],"default":"bibtex"},{"name":"sort","type":"string","description":"Sort order","oneOf":["mostrecent","mostcited"],"default":"mostrecent"},{"name":"size","type":"number","description":"Maximum records to export (the UI uses up to 1000)","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/export-literature-search?q=a+G.Bertone.1&format=bibtex&size=10"},{"command":"search-authors","summary":"Search author profiles by name","params":[{"name":"q","type":"string","required":true,"description":"Author name or query"},{"name":"sort","type":"string","description":"Sort order","default":"bestmatch"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-authors?q=witten"},{"command":"get-author","summary":"Get an author profile: name, positions, advisors, students, ids (BAI/ORCID). The author key for list-author-publications is '{control_number}_{name.preferred_name}'","params":[{"name":"id","type":"string","required":true,"description":"Author record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-author"},{"command":"search-jobs","summary":"Search HEP job postings, filtered by rank, region and open/closed status","params":[{"name":"q","type":"string","description":"Free-text query"},{"name":"status","type":"string","description":"Posting status","oneOf":["open","closed"],"default":"open"},{"name":"rank","type":"string","description":"Position rank","oneOf":["SENIOR","JUNIOR","STAFF","VISITOR","POSTDOC","PHD","MASTER","UNDERGRADUATE","OTHER"]},{"name":"region","type":"string","description":"Region","oneOf":["Africa","Asia","Australasia","Europe","Middle East","North America","South America"]},{"name":"field_of_interest","type":"string","description":"arXiv field, e.g. hep-ex, hep-ph, hep-th, astro-ph"},{"name":"sort","type":"string","description":"Sort order","oneOf":["mostrecent","deadline"],"default":"mostrecent"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-jobs?q=postdoc&status=open&rank=POSTDOC&region=Europe"},{"command":"get-job","summary":"Get a job posting's details: description, deadline, contacts, institution","params":[{"name":"id","type":"string","required":true,"description":"Job record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-job"},{"command":"search-conferences","summary":"Search conferences, upcoming or all","params":[{"name":"q","type":"string","description":"Free-text query"},{"name":"start_date","type":"string","description":"Time window","oneOf":["upcoming","all"],"default":"upcoming"},{"name":"sort","type":"string","description":"Sort order","oneOf":["dateasc","datedesc","bestmatch"],"default":"dateasc"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-conferences?q=neutrino&start_date=upcoming"},{"command":"get-conference","summary":"Get a conference's details: dates, location, contacts, description","params":[{"name":"id","type":"string","required":true,"description":"Conference record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-conference"},{"command":"search-seminars","summary":"Search seminars (upcoming or all), including seminars by a speaker or about a paper","params":[{"name":"q","type":"string","description":"Free text, or 'speakers.record.$ref:AUTHOR_ID', or 'literature_records.record.$ref:LIT_ID'"},{"name":"start_date","type":"string","description":"Time window","oneOf":["upcoming","all"],"default":"upcoming"},{"name":"sort","type":"string","description":"Sort order","oneOf":["dateasc","datedesc"],"default":"dateasc"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-seminars?q=dark+matter&start_date=upcoming"},{"command":"get-seminar","summary":"Get a seminar's details: speaker, time, timezone, abstract, join URL","params":[{"name":"id","type":"string","required":true,"description":"Seminar record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-seminar"},{"command":"search-institutions","summary":"Search research institutions by name","params":[{"name":"q","type":"string","required":true,"description":"Institution name or query"},{"name":"sort","type":"string","description":"Sort order","default":"mostrecent"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-institutions?q=CERN"},{"command":"get-institution","summary":"Get an institution's details: names, addresses, ROR/GRID ids, paper count","params":[{"name":"id","type":"string","required":true,"description":"Institution record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-institution"},{"command":"search-experiments","summary":"Search experiments and accelerators","params":[{"name":"q","type":"string","required":true,"description":"Experiment name or query"},{"name":"sort","type":"string","description":"Sort order","oneOf":["mostrecent","bestmatch"],"default":"mostrecent"},{"name":"size","type":"number","description":"Results per page","default":25},{"name":"page","type":"number","description":"Page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/search-experiments?q=ATLAS"},{"command":"get-experiment","summary":"Get an experiment's details: accelerator, collaboration, institutions, dates, description","params":[{"name":"id","type":"string","required":true,"description":"Experiment record id"}],"exampleUrl":"https://clify-dev.netlify.app/inspirehep/get-experiment"}]}