/ucdp/dyads

POST /api/ucdp/dyads

Price: 65 credits

Get a UCDP dyad — two opposing actors, or an actor and civilians in one-sided violence: type of violence, parent conflict, actors, countries, background text and the dyad's death toll since 1989 in total and by year

How to use it

Takes a state-based, non-state or one-sided dyad id alike; find one with ucdp/dyads/search or in the dyads list of ucdp/countries, ucdp/conflicts or ucdp/actors. Fatalities are UCDP best estimates.

Parameters

• access-token string required

Request body

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

Response

• @type string (default: "UcdpDyad")
• 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)
• violence_type string required (one of: "state_based", "non_state", "one_sided")
• conflict_id string nullable
• conflict_name string nullable
• countries array (default: [])
  • @type string (default: "UcdpRef")
  • id string required
  • name string nullable
• 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 dyad 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.