/ucdp/actors

POST /api/ucdp/actors

Price: 65 credits

Get a UCDP actor — a government, rebel group, militia or organised group: profile text, the countries, conflicts and dyads it takes part in, the actors it fought, and the death toll of the violence it was party to since 1989

How to use it

Find the id with ucdp/actors/search. The death toll counts every event the actor was a side of, in total, by type of violence and by year, as UCDP best estimates.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• actor string required — UCDP actor id or the actor's UCDP page URL (examples: "8118", "https://ucdp.uu.se/actor/9546"; minLength: 1; maxLength: 200)

Response

• @type string (default: "UcdpActor")
• id string required
• name string required
• url string required
• description string nullable
• additional_info string nullable
• fatalities integer nullable
• state_based_fatalities integer nullable
• non_state_fatalities integer nullable
• one_sided_fatalities integer nullable
• events_count integer nullable
• first_event_year integer nullable
• last_event_year integer nullable
• fatalities_by_year array (default: [])
  • @type string (default: "UcdpYearFatalities")
  • year integer required
  • fatalities integer (default: 0)
  • state_based_fatalities integer (default: 0)
  • non_state_fatalities integer (default: 0)
  • one_sided_fatalities integer (default: 0)
  • events_count integer (default: 0)
• countries array (default: [])
  • @type string (default: "UcdpRef")
  • id string required
  • name string nullable
• conflicts array (default: [])
  • @type string (default: "UcdpRef")
  • id string required
  • name string nullable
• dyads array (default: [])
  • @type string (default: "UcdpDyadRef")
  • id string required
  • name string nullable
  • violence_type string nullable (one of: "state_based", "non_state", "one_sided")
  • conflict_id string nullable
  • conflict_name string nullable
• related_actors array (default: [])
  • @type string (default: "UcdpRef")
  • id string required
  • name 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 — UCDP has no actor under this id 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.