{"openapi":"3.1.0","info":{"title":"Rijksfinancien: Open API","description":"This page contains a description of the API calls used to generate the visualisation on the homepage. By clicking on the call you can get more details about the required parameters and the return values. With the \u0022Try it out\u0022 button you can also test the call yourself.","version":"1.0.0"},"paths":{"\/open-data\/api\/json\/budgettaire_tabellen":{"get":{"tags":["Budgettaire Tabellen"],"summary":"(json) Query the budgettaire tabellen data","description":"Query the budgettaire tabellen data","operationId":"bt_query_data_json","parameters":[{"$ref":"#\/components\/parameters\/year--query"},{"$ref":"#\/components\/parameters\/phase--query"},{"$ref":"#\/components\/parameters\/vuo--bt"},{"$ref":"#\/components\/parameters\/chapter--bt"},{"$ref":"#\/components\/parameters\/chapter_name--bt"},{"$ref":"#\/components\/parameters\/article--bt"},{"$ref":"#\/components\/parameters\/article_name--bt"},{"$ref":"#\/components\/parameters\/sub_article--bt"},{"$ref":"#\/components\/parameters\/minister--bt"}],"responses":{"200":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"array","items":{"properties":{"index":{"type":"string"},"jaar":{"type":"integer"},"fase":{"type":"string"},"verantwoordelijk_minister":{"type":"string"},"hoofdstuk_naam":{"type":"string"},"hoofdstuk_nummer":{"type":"string"},"artikel_naam":{"type":"string"},"artikel_nummer":{"type":"string"},"beleid_of_niet_beleid":{"type":"string"},"rbv_model":{"type":"string"},"artikelonderdeel_naam":{"type":"string"},"artikelonderdeel_nummer":{"type":"string"},"instrument_of_uitsplitsing_apparaat_naam":{"type":"string"},"instrument_of_uitsplitsing_apparaat_nummer":{"type":"string"},"regeling_detailniveau_naam":{"type":"string"},"regeling_detailniveau_nummer":{"type":"string"},"vuo":{"type":"string"},"bedrag":{"type":"integer"}},"type":"object"}}}}},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/budgettaire_tabellen":{"get":{"tags":["Budgettaire Tabellen"],"summary":"(csv) Query the budgettaire tabellen data","description":"Query the budgettaire tabellen data","operationId":"bt_query_data_csv","parameters":[{"$ref":"#\/components\/parameters\/year--query"},{"$ref":"#\/components\/parameters\/phase--query"},{"$ref":"#\/components\/parameters\/vuo--bt"},{"$ref":"#\/components\/parameters\/chapter--bt"},{"$ref":"#\/components\/parameters\/chapter_name--bt"},{"$ref":"#\/components\/parameters\/article--bt"},{"$ref":"#\/components\/parameters\/article_name--bt"},{"$ref":"#\/components\/parameters\/sub_article--bt"},{"$ref":"#\/components\/parameters\/minister--bt"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/financiele_instrumenten":{"get":{"tags":["Financiele instrumenten (v1)"],"summary":"Get data","description":"Json data for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_v1","parameters":[{"name":"year[]","in":"query","description":"The calendar years","required":true,"schema":{"type":"array","items":{"type":"integer","example":2019}}},{"name":"regulation[]","in":"query","description":"The name of the regulation","required":false,"schema":{"type":"array","items":{"type":"string","example":"Subsidieregeling BZ 2006"}}},{"name":"receiver[]","in":"query","description":"The name of the receiver","required":false,"schema":{"type":"array","items":{"type":"string","example":"Auschwitz Institute For Peace And Reconciliation New York"}}},{"name":"instrument[]","in":"query","description":"The name of the instrument","required":false,"schema":{"type":"array","items":{"type":"string","example":"Subsidies(regelingen)"}}}],"responses":{"200":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"array","items":{}}}}},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/financiele_instrumenten\/instruments":{"get":{"tags":["Financiele instrumenten (v1)"],"summary":"Get available instruments","description":"List of available instruments for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_v1_instruments","responses":{"200":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"array","items":{}}}}},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/v2\/financiele_instrumenten":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(json) Get data","description":"Json data for the for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_json_v2","parameters":[{"name":"referrer","in":"query","description":"The referrer","required":true,"schema":{"type":"string","enum":["artikel","hoofdstuk","ontvanger","regeling"],"example":"ontvanger"}},{"name":"referrer_id","in":"query","description":"The id of the referrer","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of data to return","required":false,"schema":{"type":"string","enum":["artikel","hoofdstuk","ontvanger","regeling"],"example":"hoofdstuk"}},{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/200--financiele-instrumenten"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/v2\/financiele_instrumenten":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(csv) Get data","description":"CSV data for the for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_csv_v2","parameters":[{"name":"referrer","in":"query","description":"The referrer","required":true,"schema":{"type":"string","enum":["artikel","hoofdstuk","ontvanger","regeling"],"example":"ontvanger"}},{"name":"referrer_id","in":"query","description":"The id of the referrer","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of data to return","required":false,"schema":{"type":"string","enum":["artikel","hoofdstuk","ontvanger","regeling"],"example":"hoofdstuk"}},{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/v2\/financiele_instrumenten\/artikelen":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(json) Get \u0022artikelen\u0022","description":"List of available \u0022artikelen\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_json_v2_artikelen","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/200--financiele-instrumenten-search"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/v2\/financiele_instrumenten\/artikelen":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(csv) Get \u0022artikelen\u0022","description":"List of available \u0022artikelen\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_csv_v2_artikelen","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/v2\/financiele_instrumenten\/hoofdstukken":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(json) Get \u0022hoofdstukken\u0022","description":"List of available \u0022hoofdstukken\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_json_v2_hoofdstukken","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/200--financiele-instrumenten-search"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/v2\/financiele_instrumenten\/hoofdstukken":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(csv) Get \u0022hoofdstukken\u0022","description":"List of available \u0022hoofdstukken\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_csv_v2_hoofdstukken","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/v2\/financiele_instrumenten\/regelingen":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(json) Get \u0022regelingen\u0022","description":"List of available \u0022regelingen\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_json_v2_regelingen","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/200--financiele-instrumenten-search"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/v2\/financiele_instrumenten\/regelingen":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(csv) Get \u0022regelingen\u0022","description":"List of available \u0022regelingen\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_csv_v2_regelingen","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/v2\/financiele_instrumenten\/ontvangers":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(json) Get \u0022ontvangers\u0022","description":"List of available \u0022ontvangers\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_json_v2_ontvangers","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/200--financiele-instrumenten-search"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/v2\/financiele_instrumenten\/ontvangers":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"(csv) Get \u0022ontvangers\u0022","description":"List of available \u0022ontvangers\u0022 for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_csv_v2_ontvangers","parameters":[{"$ref":"#\/components\/parameters\/year--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/search--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/sort--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/min--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/max--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/limit--financiele-instrumenten"},{"$ref":"#\/components\/parameters\/start--financiele-instrumenten"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/v2\/financiele_instrumenten\/available_years":{"get":{"tags":["Financiele instrumenten (v2)"],"summary":"Get available years","description":"Get the available years for the \u0022Wie ontvingen\u0022 chart","operationId":"wie_ontvingen_json_v2_available_years","responses":{"200":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/json\/fiscale_regelingen\/{year}":{"get":{"tags":["Fiscale regelingen"],"summary":"(json) get data","description":"Json data for the \u0022Fiscale regelingen\u0022 chart","operationId":"fiscale_regelingen_json","parameters":[{"$ref":"#\/components\/parameters\/year--path"}],"responses":{"200":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"array","items":{"properties":{"label":{"type":"string"},"classname":{"type":"string"},"parts":{"properties":{"begroting":{"type":"integer"},"premie":{"type":"integer"},"fiscaal":{"type":"integer"}},"type":"object"},"children":{"type":"array","items":{"properties":{"label":{"type":"string"},"parts":{"properties":{"begroting":{"type":"integer"},"premie":{"type":"integer"},"fiscaal":{"type":"integer"}},"type":"object"},"key":{"type":"string"}},"type":"object"}},"key":{"type":"string"}},"type":"object"}}}}},"404":{"$ref":"#\/components\/responses\/404"}}}},"\/open-data\/api\/csv\/fiscale_regelingen\/{year}":{"get":{"tags":["Fiscale regelingen"],"summary":"(csv) get data","description":"CSV data for the \u0022Fiscale regelingen\u0022 chart","operationId":"fiscale_regelingen_csv","parameters":[{"$ref":"#\/components\/parameters\/year--path"}],"responses":{"200":{"$ref":"#\/components\/responses\/generic-csv"},"404":{"$ref":"#\/components\/responses\/404"}}}}},"components":{"responses":{"200--financiele-instrumenten":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"array","items":{"properties":{"type":{"type":"string"},"referrer":{"type":"string"},"referrer_id":{"type":"string"},"year":{"type":"integer"},"title":{"type":"string"},"max":{"type":"integer"},"min":{"type":"integer"},"total":{"type":"integer"},"total_results":{"type":"integer"},"records_show":{"type":"integer"},"records_start":{"type":"integer"},"result":{"type":"array","items":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"amount":{"type":"integer"}},"type":"object"}}},"type":"object"}}}}},"200--financiele-instrumenten-search":{"description":"Successfull call","content":{"application\/json":{"schema":{"type":"array","items":{"properties":{"jaar":{"type":"integer"},"search":{"type":["string","null"]},"max":{"type":"integer"},"min":{"type":"integer"},"total":{"type":"integer"},"total_results":{"type":"integer"},"records_show":{"type":"integer"},"records_start":{"type":"integer"},"result":{"type":"array","items":{"properties":{"id":{"type":"string"},"titel":{"type":"string"},"bedrag":{"type":"integer"}},"type":"object"}}},"type":"object"}}}}},"404":{"description":"No data found for the requested parameters.","content":{"application\/json":{"schema":{},"examples":{"Failed call":{"summary":"Failed call","value":"[]"}}}}},"generic-csv":{"description":"A CSV file","headers":{"application\/CSV":{"schema":{}}}}},"parameters":{"vuo--bt":{"name":"vuo","in":"query","description":"Use \u0022U\u0022 to get the data for the \u0022expenditures\u0022.\u003Cbr \/\u003EUse \u0022O\u0022 to get the data for the \u0022revenues\u0022.\u003Cbr \/\u003EUse \u0022V\u0022 to get the data for the \u0022obligations\u0022","required":false,"schema":{"type":"string","enum":["U","O","V"],"example":"U"}},"chapter--bt":{"name":"chapter","in":"query","description":"The chapter id","required":false,"schema":{"type":"string","example":"I"}},"chapter_name--bt":{"name":"chapter_name","in":"query","description":"Partial search on the chapter name","required":false,"schema":{"type":"string","example":"Koning"}},"article--bt":{"name":"article","in":"query","description":"The article id","required":false,"schema":{"type":"string","example":"2"}},"article_name--bt":{"name":"article_name","in":"query","description":"Partial search on the article name","required":false,"schema":{"type":"string","example":"uitgaven"}},"sub_article--bt":{"name":"sub_article","in":"query","description":"The sub-article id","required":false,"schema":{"type":"string","example":"24958"}},"minister--bt":{"name":"minister","in":"query","description":"Partial search on the name of the responsible minister","required":false,"schema":{"type":"string","example":"Rutte"}},"year--financiele-instrumenten":{"name":"jaar","in":"query","description":"A calendar year","required":false,"schema":{"type":"integer","example":2020}},"search--financiele-instrumenten":{"name":"search","in":"query","description":"Search string for a search on the title","required":false,"schema":{"type":"string","example":"onderwijs"}},"sort--financiele-instrumenten":{"name":"sort","in":"query","description":"The sorting to user","required":false,"schema":{"type":"string","enum":["amount desc","amount asc","name_string desc","name_string asc","score desc","score asc"],"example":"amount desc"}},"min--financiele-instrumenten":{"name":"min","in":"query","description":"The minimum amount","required":false,"schema":{"type":"integer","example":1000}},"max--financiele-instrumenten":{"name":"max","in":"query","description":"The maximum amount","required":false,"schema":{"type":"integer","example":100000}},"limit--financiele-instrumenten":{"name":"limit","in":"query","description":"The amount or records to return, defaults to 25. Max is also 25","required":false,"schema":{"type":"integer","example":25}},"start--financiele-instrumenten":{"name":"start","in":"query","description":"The offset or records to return, defaults to 0","required":false,"schema":{"type":"integer","example":0}},"year--path":{"name":"year","in":"path","description":"A calendar year","required":true,"schema":{"type":"integer","example":2020}},"year--query":{"name":"year","in":"query","description":"A calendar year","required":true,"schema":{"type":"integer","example":2020}},"phase--path":{"name":"phase","in":"path","description":"The phase you want to receive data for.\u003Cbr \/\u003EUse \u0022OWB\u0022 to get the data for the \u0022Annual budget\u0022.\u003Cbr \/\u003EUse \u0022JV\u0022 to get the data for the \u0022year report\u0022.\u003Cbr \/\u003E\u003EUse \u0022O1\u0022 and \u0022O2\u0022 to get the data for the \u0022first\/second supplementary budget\u0022","required":true,"schema":{"type":"string","enum":["OWB","O1","O2","JV"],"example":"OWB"}},"phase--query":{"name":"phase","in":"query","description":"The phase you want to receive data for.\u003Cbr \/\u003EUse \u0022OWB\u0022 to get the data for the \u0022Annual budget\u0022.\u003Cbr \/\u003EUse \u0022JV\u0022 to get the data for the \u0022year report\u0022.\u003Cbr \/\u003EUse \u0022O1\u0022 and \u0022O2\u0022 to get the data for the \u0022first\/second supplementary budget\u0022","required":true,"schema":{"type":"string","enum":["OWB","O1","O2","JV"],"example":"OWB"}}}},"tags":[{"name":"Budgettaire Tabellen","description":"Budgettaire Tabellen"},{"name":"Financiele instrumenten (v1)","description":"Financiele instrumenten (v1)"},{"name":"Financiele instrumenten (v2)","description":"Financiele instrumenten (v2)"},{"name":"Fiscale regelingen","description":"Fiscale regelingen"}]}