/ieee/papers/references

POST /api/ieee/papers/references

Price: 1 credit

List the works one IEEE Xplore paper cites, in the order the paper prints them. Each reference carries the citation text as printed, the parsed title, the reference type, and — where IEEE resolved the cited work — its article number, DOI and the links to the record, its PDF and CrossRef

How to use it

IEEE has reference data for part of its corpus only, so an empty result means the paper's bibliography was never captured rather than that it cites nothing. `article_number` is filled only for a cited work that is itself in IEEE Xplore, and it resolves through /ieee/papers; for everything else read `text`, which is the reference exactly as the paper printed it.

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, or the address of the document page (examples: "11007439", "EDP590", "https://ieeexplore.ieee.org/document/11007439/"; minLength: 1)
• count integer required — Number of records to return (examples: 100; min: 1)

Response

• @type string (default: "IeeeReference")
• id string required
• paper_id string required
• order integer nullable
• reference_type string nullable
• text string nullable
• article_number string nullable
• doi string nullable
• document_url string nullable
• pdf_url string nullable
• pdf_size_kb integer nullable
• crossref_url string nullable
• google_scholar_url string nullable
• notice_url 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.