/ieee/publications/toc

POST /api/ieee/publications/toc

Price: 10 credits

List everything IEEE Xplore holds under one publication — a journal, a magazine, one conference's proceedings or a book — optionally narrowed to a single issue. Each record carries the article number, title, abstract, authors with their IEEE author ids, year, volume, issue, pages, DOI and the citation and download counts

How to use it

The publication number is not the article number: take it from a paper's `publication_number`, or from the `/xpl/conhome/...`, `/xpl/RecentIssue.jsp?punumber=...` or `/book/...` address IEEE prints. A large journal holds far more papers than the 10,000 IEEE Xplore will serve for one listing, so reach a specific volume through `issue_number` rather than by paging. Without `sort` the order is IEEE's own and is not chronological. A publication number IEEE does not know, and an article number passed here in place of one, are both errors rather than an empty list, so an empty list means IEEE holds no papers under a publication it does know.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• publication_number string required — IEEE Xplore publication number of the journal, magazine, conference proceedings or book, or the address of its IEEE Xplore page (examples: "6287639", "11007291", "https://ieeexplore.ieee.org/xpl/conhome/11007291/proceeding", "https://ieeexplore.ieee.org/book/10950239"; minLength: 1)
• issue_number string nullable — Narrow the listing to one issue, given as the issue number a paper reports in `issue_number` (examples: "11007332"; minLength: 1)
• sort string nullable — Result ordering. Left unset, IEEE Xplore uses its own default order (one of: "newest", "oldest", "paper-citations", "patent-citations", "most-popular", "pub-title-asc", "pub-title-desc")
• count integer required — Number of records to return (examples: 100; min: 1; max: 10000)

Response

• @type string (default: "IeeePaperHit")
• id string required
• url string required
• abstract string nullable
• doi string nullable
• content_type string nullable
• content_type_display string nullable
• collection string nullable
• publisher string nullable
• publication_title string nullable
• publication_number string nullable
• publication_url string nullable
• publication_year integer nullable
• publication_date string nullable
• issue_number string nullable
• volume string nullable
• issue string nullable
• start_page string nullable
• end_page string nullable
• authors array (default: [])
  • @type string (default: "IeeeHitAuthor")
  • id string nullable
  • name string nullable
  • normalized_name string nullable
  • first_name string nullable
  • last_name string nullable
• major_topic string nullable
• citation_count integer nullable
• patent_citation_count integer nullable
• download_count integer nullable
• access_type string nullable
• access_message string nullable
• is_early_access boolean nullable
• is_online_only boolean nullable
• is_ephemera boolean nullable
• is_latest_standard boolean nullable
• has_standard_versions boolean nullable
• pdf_url string nullable
• pdf_size_kb integer nullable
• book_pdf_url string nullable
• citations_url string nullable
• patent_citations_url string nullable
• multimedia_url string nullable
• rights_url string nullable
• image string nullable
• graphical_abstract object nullable
  • @type string (default: "IeeeGraphicalAbstract")
  • summary string nullable
  • image string nullable
  • file_size string nullable
• supplements array (default: [])
  • @type string (default: "IeeeSupplementGroup")
  • kind string nullable
  • repository string nullable
  • badge string nullable
  • badge_message string nullable
  • files array (default: [])
    • @type string (default: "IeeeSupplementItem")
    • name string nullable
    • doi string nullable
    • url string nullable
    • widget_url string nullable
    • language string nullable
    • badge_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — IEEE Xplore has no record with this identifier Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.