/ieee/authors/coauthors

POST /api/ieee/authors/coauthors

Price: 10 credits

List the people IEEE Xplore records as co-authors of one author, each with their own author id and page, current affiliations, ORCID, photo, and the number of records, citations and joint publications IEEE counts for them

How to use it

`article_count` is the co-author's own output in IEEE Xplore, while `published_count` is the narrower figure IEEE records alongside it and is never larger — rank collaborators by `published_count` and judge a person's output by `article_count`. Each `id` resolves through /ieee/authors, which is how a collaboration graph is walked one hop further. An author whose IEEE Xplore record carries no joint work returns an empty list, while an id IEEE does not know is an error, so emptiness here means sole-author work rather than a bad id.

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)
• count integer required — Number of co-authors to return (examples: 100; min: 1)

Response

• @type string (default: "IeeeCoauthor")
• id string required
• url string required
• name string nullable
• last_name string nullable
• affiliations array (default: [])
• orcid string nullable
• image string nullable
• article_count integer nullable
• citation_count integer nullable
• published_count integer 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.