/ieee/papers

POST /api/ieee/papers

Price: 1 credit

Get one IEEE Xplore record by article number, document address or DOI: title, abstract, authors with their affiliations, ORCIDs and IEEE author ids, the journal, conference, book or standard it appeared in, year, volume, issue, pages, ISSNs and ISBNs, indexing keywords, topics, sponsors, funding agencies, citation and reference counts, the copyright or open-access licence code, and the links IEEE publishes for the record, its PDF and the rights holder

How to use it

An article number is not always digits — IEEE Courses use forms like `EDP590` — so pass it as a string and never cast it to an integer. A DOI is accepted as well and resolves to exactly one record. `content_type` separates a conference paper from a journal article, a book chapter, a magazine piece, a standard and a course, and the standards fields `standard_number`, `standard_status`, `scope` and `purpose` are filled only for standards. A missing `doi` means IEEE records none, which is common for older and non-IEEE-published items.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — IEEE Xplore article number, the address of the document page, or the paper's DOI (examples: "11007439", "EDP590", "https://ieeexplore.ieee.org/document/11007439/", "10.1109/ISML60050.2024.11007439"; minLength: 1)

Response

• @type string (default: "IeeePaper")
• id string required
• url string required
• doi string nullable
• doi_url string nullable
• abstract string nullable
• content_type string nullable
• document_type string nullable
• sub_type 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
• display_publication_date string nullable
• issue_number string nullable
• issue_url string nullable
• volume string nullable
• issue string nullable
• start_page string nullable
• end_page string nullable
• page_count integer nullable
• edition string nullable
• authors array (default: [])
  • @type string (default: "IeeePaperAuthor")
  • id string nullable
  • name string nullable
  • first_name string nullable
  • last_name string nullable
  • affiliations array (default: [])
  • orcid string nullable
  • bio string nullable
  • image string nullable
  • ringgold_id string nullable
• editors array (default: [])
  • @type string (default: "IeeePaperAuthor")
  • id string nullable
  • name string nullable
  • first_name string nullable
  • last_name string nullable
  • affiliations array (default: [])
  • orcid string nullable
  • bio string nullable
  • image string nullable
  • ringgold_id string nullable
• keywords array (default: [])
  • @type string (default: "IeeeKeywordGroup")
  • id string required
  • paper_id string required
  • vocabulary string required
  • terms array (default: [])
• topics array (default: [])
• subject_categories array (default: [])
• societies array (default: [])
• issns array (default: [])
  • @type string (default: "IeeeIdentifier")
  • label string nullable
  • value string nullable
• isbns array (default: [])
  • @type string (default: "IeeeIdentifier")
  • label string nullable
  • value string nullable
• standard_number string nullable
• standard_status string nullable
• standard_revision string nullable
• ics_codes array (default: [])
  • @type string (default: "IeeeIcsCode")
  • code string nullable
  • term string nullable
• scope string nullable
• purpose string nullable
• conference_location string nullable
• sponsors array (default: [])
  • @type string (default: "IeeeSponsor")
  • name string nullable
  • url string nullable
• funding_agencies array (default: [])
  • @type string (default: "IeeeFundingAgency")
  • name string nullable
  • grant_number string nullable
  • funding_id 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
• graphical_abstract object nullable
  • @type string (default: "IeeeGraphicalAbstract")
  • summary string nullable
  • image string nullable
  • file_size string nullable
• citation_count integer nullable
• reference_count integer nullable
• pubmed_id string nullable
• copyright_owner string nullable
• copyright_year integer nullable
• copyright_notice string nullable
• copyright_code string nullable
• is_open_access boolean nullable
• is_early_access boolean nullable
• is_free boolean nullable
• is_online_only boolean nullable
• is_translation boolean nullable
• is_ephemera boolean nullable
• is_latest_standard boolean nullable
• has_standard_versions boolean nullable
• pdf_url string nullable
• epub_url string nullable
• rights_url string nullable
• image string nullable
• cover string nullable
• indexed_date string nullable
• updated_date 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 — No IEEE Xplore document 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.