{"openapi":"3.1.0","info":{"title":"CBI open research API","version":"1.0.0","description":"Dated evidence-qualified research with explicit gaps. No personal eligibility or admission decisions."},"servers":[{"url":"https://cbi.me"}],"paths":{"/api/v1/statistics/{id}":{"get":{"operationId":"_statistics__id_","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"measure","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":8192}},{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/programmes":{"get":{"operationId":"_programmes","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"kind","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"jurisdiction","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"stage","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":8192}},{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/programmes/{id}":{"get":{"operationId":"_programmes__id_","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/programmes/{id}/costs":{"get":{"operationId":"_programmes__id__costs","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"option","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"scenario","in":"query","required":false,"schema":{"type":"string","enum":["single_adult","couple_two_children_under12"]}},{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/compare":{"get":{"operationId":"_compare","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"ids","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"scenario","in":"query","required":false,"schema":{"type":"string","enum":["single_adult","couple_two_children_under12"]}},{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/travel-rules":{"get":{"operationId":"_travel_rules","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"passport","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"destination","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"documentType","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"purpose","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"transport","in":"query","required":false,"schema":{"type":"string","enum":["air","land","sea","unknown"]}},{"name":"qualifyingVisa","in":"query","required":false,"schema":{"type":"string","enum":["yes","no","unknown"]}},{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/sources/{id}":{"get":{"operationId":"_sources__id_","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/changes":{"get":{"operationId":"_changes","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"to","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"programme","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":8192}},{"name":"include","in":"query","required":false,"schema":{"type":"string","const":"evidence"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/coverage":{"get":{"operationId":"_coverage","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/releases":{"get":{"operationId":"_releases","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":8192}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}},"/api/v1/releases/{id}":{"get":{"operationId":"_releases__id_","description":"Strict bounded query. See versioned API documentation for parameters and domain outcomes.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"}},{"name":"release","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Evidence-qualified envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Unsupported or malformed parameter"},"404":{"description":"Unknown record or release"},"410":{"description":"Withdrawn or retired release"},"413":{"description":"Request or response exceeds bounds"},"503":{"description":"Data integrity or dependency failure"}}}}},"components":{"schemas":{"Envelope":{"type":"object","required":["schemaVersion","datasetRelease","generatedAt","evaluatedAt","coverage","warnings","data"],"properties":{"schemaVersion":{"type":"string"},"datasetRelease":{"type":"string"},"generatedAt":{"type":"string","format":"date-time"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object"},"evidence":{"type":"array","items":{"type":"object"}}},"additionalProperties":false}}}}