/datacite/clients/search

POST /api/datacite/clients/search

Price: 1 credit

Search DataCite clients (data repositories)

How to use it

Search DataCite clients (data repositories that deposit DOIs) by free-text query, owning provider or join year. Each result is a full repository record with name, description, URL, type, domains, re3data/OpenDOAR references, ISSNs and the owning provider id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Free-text search across repository metadata
• provider_id string nullable — Filter by owning provider id
• year string nullable — Filter by year the repository joined
• count integer required — Number of repositories to return (min: 1)

Response

• @type string (default: "DataciteClient")
• id string required
• name string nullable
• alternate_name string nullable
• symbol string nullable
• description string nullable
• url string nullable
• client_type string nullable
• domains string nullable
• re3data string nullable
• opendoar string nullable
• issn object nullable
  • @type string (default: "DataciteIssn")
  • issnl string nullable
  • print string nullable
  • electronic string nullable
• languages array (default: [])
• year integer nullable
• is_active boolean nullable
• created_at string nullable
• updated_at string nullable
• provider_id 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 — The entity was not found, or a precondition failed 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.