/ieee/authors

POST /api/ieee/authors

Price: 5 credits

Get one IEEE Xplore author profile by id: preferred name, name variants, current affiliations, ORCID, photo, the biography IEEE printed with one of their papers, the number of records and citations IEEE counts, the first and last year the author published, the topics IEEE associates with them with a record count each, publications per year, and the co-authors IEEE links to the profile

How to use it

Author ids come in two lengths, an 11-digit legacy number and a 15-digit one, and both resolve here; take one from a paper's `authors[].id` rather than searching by name, because IEEE keeps separate profiles for name variants and `name` on a profile can be spelled differently from the same person's name on a paper. `article_count` counts what IEEE Xplore holds, not the author's whole output. For co-authors with their own affiliations, ORCIDs and counts, use /ieee/authors/coauthors.

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 author id, or the address of the author's IEEE Xplore page (examples: "37086012801", "391049313877833", "https://ieeexplore.ieee.org/author/37086012801"; minLength: 1)

Response

• @type string (default: "IeeeAuthor")
• id string required
• url string required
• name string required
• first_name string nullable
• last_name string nullable
• aliases array (default: [])
• affiliations array (default: [])
• orcid string nullable
• image string nullable
• bio string nullable
• bio_date string nullable
• bio_paper_id string nullable
• contact_email string nullable
• article_count integer nullable
• citation_count integer nullable
• first_published_year integer nullable
• last_published_year integer nullable
• is_hidden boolean nullable
• topics array (default: [])
  • @type string (default: "IeeeAuthorTopic")
  • name string nullable
  • record_count integer nullable
• publication_years array (default: [])
  • @type string (default: "IeeeAuthorYear")
  • year integer nullable
  • record_count integer nullable
• coauthors array (default: [])
  • @type string (default: "IeeeAuthorRef")
  • id string nullable
  • name string nullable
  • first_name string nullable
  • last_name string nullable
  • url string nullable
  • is_hidden boolean 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.