{ "openapi": "3.0.3", "info": { "title": "GrantData - Canadian Government Grants & Research Funding API", "description": "Canadian government grants and research funding API. Federal proactive disclosure, Infrastructure Canada projects, NSERC and SSHRC research grants. Filter by department, recipient, program, agreement type, value.", "version": "0.1.0" }, "paths": { "/health": { "get": { "summary": "Health", "operationId": "/health", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/department/{name}": { "get": { "summary": "Department procurement profile", "operationId": "/department/{name}", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "department": "Department of National Defence", "total_contracts": 12500, "total_value": 8500000000.0, "top_vendors": [ { "vendor_name": "General Dynamics", "count": 120 }, { "vendor_name": "CAE Inc", "count": 95 } ], "by_category": [ { "category": "SRV", "count": 6800 }, { "category": "GD", "count": 3200 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/recipient/{name}": { "get": { "summary": "Grant recipient profile", "operationId": "/recipient/{name}", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "department", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Department filter (partial match)" }, { "name": "agreement_type", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "grant, contribution, or other" }, { "name": "issued_after", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date >= YYYY-MM-DD (start_date for grants, approved_date for infrastructure, fiscal_year for research)" }, { "name": "issued_before", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date <= YYYY-MM-DD" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Sort by: value, date" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "description": "asc or desc", "default": "desc", "title": "Sort Order" }, "description": "asc or desc" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "recipient": "University of Toronto", "total_records": 245, "total_value": 12500000.0, "by_agreement_type": { "grant": { "count": 180, "total_value": 9200000.0 }, "contribution": { "count": 65, "total_value": 3300000.0 } }, "top_departments": [ { "department": "Natural Sciences and Engineering Research Council", "count": 120, "total_value": 6500000.0 } ], "top_programs": [ { "program": "Discovery Grants Program", "count": 85, "total_value": 4200000.0 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/grant": { "get": { "summary": "Search federal grants and contributions", "operationId": "/grant", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Full-text search across data fields" }, { "name": "department", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by department name (partial match, EN or FR)" }, { "name": "recipient_name", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Grant recipient name (partial match)" }, { "name": "agreement_type", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Agreement type: grant, contribution, other" }, { "name": "program", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Program name (partial match, grant)" }, { "name": "program_exact", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Program name (exact match, grant). Faster than program= for known names." }, { "name": "recipient_province", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Recipient province (grant)" }, { "name": "value_min", "in": "query", "required": false, "schema": { "type": "number", "nullable": true }, "description": "Minimum contract value (numeric)" }, { "name": "value_max", "in": "query", "required": false, "schema": { "type": "number", "nullable": true }, "description": "Maximum contract value (numeric)" }, { "name": "issued_after", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date >= YYYY-MM-DD (start_date for grants, approved_date for infrastructure, fiscal_year for research)" }, { "name": "issued_before", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date <= YYYY-MM-DD" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Sort field: published (publication_date for tenders, award_date for contracts), date (event date), value (contract/agreement value)" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort order: asc or desc", "default": "desc", "title": "Sort Order" }, "description": "Sort order: asc or desc" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Pagination cursor from next_cursor in a previous response. Use instead of offset for deep pagination." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "entity_type": "grant", "count": 1, "offset": 0, "results": [ { "record_id": "ASC-25/26-070-C", "recipient_legal_name": "Canadian Standards Association", "department": "Accessibility Standards Canada", "program_en": "Advancing Accessibility Standards Research", "program_fr": "Avancement de la recherche sur les normes d'accessibilit\u00e9", "agreement_type": "contribution", "agreement_value": 79365.0, "start_date": "2020-03-23", "end_date": "2021-02-19", "recipient_province": "ON", "recipient_city": "Toronto" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/infrastructure_project": { "get": { "summary": "Search Infrastructure Canada projects", "operationId": "/infrastructure_project", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Full-text search across data fields" }, { "name": "department", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by department name (partial match, EN or FR)" }, { "name": "program", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Program name (partial match, grant)" }, { "name": "program_exact", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Program name (exact match, grant). Faster than program= for known names." }, { "name": "value_min", "in": "query", "required": false, "schema": { "type": "number", "nullable": true }, "description": "Minimum contract value (numeric)" }, { "name": "value_max", "in": "query", "required": false, "schema": { "type": "number", "nullable": true }, "description": "Maximum contract value (numeric)" }, { "name": "issued_after", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date >= YYYY-MM-DD (start_date for grants, approved_date for infrastructure, fiscal_year for research)" }, { "name": "issued_before", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date <= YYYY-MM-DD" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Sort field: published (publication_date for tenders, award_date for contracts), date (event date), value (contract/agreement value)" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort order: asc or desc", "default": "desc", "title": "Sort Order" }, "description": "Sort order: asc or desc" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Pagination cursor from next_cursor in a previous response. Use instead of offset for deep pagination." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "entity_type": "grant", "count": 1, "offset": 0, "results": [ { "record_id": "ASC-25/26-070-C", "recipient_legal_name": "Canadian Standards Association", "department": "Accessibility Standards Canada", "program_en": "Advancing Accessibility Standards Research", "program_fr": "Avancement de la recherche sur les normes d'accessibilit\u00e9", "agreement_type": "contribution", "agreement_value": 79365.0, "start_date": "2020-03-23", "end_date": "2021-02-19", "recipient_province": "ON", "recipient_city": "Toronto" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/research_grant": { "get": { "summary": "Search NSERC and SSHRC research grants", "operationId": "/research_grant", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Full-text search across data fields" }, { "name": "department", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by department name (partial match, EN or FR)" }, { "name": "program", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Program name (partial match, grant)" }, { "name": "program_exact", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Program name (exact match, grant). Faster than program= for known names." }, { "name": "value_min", "in": "query", "required": false, "schema": { "type": "number", "nullable": true }, "description": "Minimum contract value (numeric)" }, { "name": "value_max", "in": "query", "required": false, "schema": { "type": "number", "nullable": true }, "description": "Maximum contract value (numeric)" }, { "name": "issued_after", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date >= YYYY-MM-DD (start_date for grants, approved_date for infrastructure, fiscal_year for research)" }, { "name": "issued_before", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Filter by date <= YYYY-MM-DD" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Sort field: published (publication_date for tenders, award_date for contracts), date (event date), value (contract/agreement value)" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort order: asc or desc", "default": "desc", "title": "Sort Order" }, "description": "Sort order: asc or desc" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Pagination cursor from next_cursor in a previous response. Use instead of offset for deep pagination." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "entity_type": "grant", "count": 1, "offset": 0, "results": [ { "record_id": "ASC-25/26-070-C", "recipient_legal_name": "Canadian Standards Association", "department": "Accessibility Standards Canada", "program_en": "Advancing Accessibility Standards Research", "program_fr": "Avancement de la recherche sur les normes d'accessibilit\u00e9", "agreement_type": "contribution", "agreement_value": 79365.0, "start_date": "2020-03-23", "end_date": "2021-02-19", "recipient_province": "ON", "recipient_city": "Toronto" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/grant/stats": { "get": { "summary": "Grant statistics", "operationId": "/grant/stats", "parameters": [ { "name": "group_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Data field to group by" }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "description": "30d, 90d, 1y, all", "default": "30d", "title": "Period" }, "description": "30d, 90d, 1y, all" }, { "name": "sum_field", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Data field to sum (e.g. contract_value)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "entity_type": "grant", "period_days": 365, "total_in_db": 1150000, "by_agreement_type": [ { "value": "contribution", "count": 650000 }, { "value": "grant", "count": 480000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/infrastructure_project/stats": { "get": { "summary": "Infrastructure project statistics", "operationId": "/infrastructure_project/stats", "parameters": [ { "name": "group_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Data field to group by" }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "description": "30d, 90d, 1y, all", "default": "30d", "title": "Period" }, "description": "30d, 90d, 1y, all" }, { "name": "sum_field", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Data field to sum (e.g. contract_value)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "entity_type": "grant", "period_days": 365, "total_in_db": 1150000, "by_agreement_type": [ { "value": "contribution", "count": 650000 }, { "value": "grant", "count": 480000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/research_grant/stats": { "get": { "summary": "Research grant statistics", "operationId": "/research_grant/stats", "parameters": [ { "name": "group_by", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Data field to group by" }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "description": "30d, 90d, 1y, all", "default": "30d", "title": "Period" }, "description": "30d, 90d, 1y, all" }, { "name": "sum_field", "in": "query", "required": false, "schema": { "type": "string", "nullable": true }, "description": "Data field to sum (e.g. contract_value)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "entity_type": "grant", "period_days": 365, "total_in_db": 1150000, "by_agreement_type": [ { "value": "contribution", "count": 650000 }, { "value": "grant", "count": 480000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/grant/{record_id}": { "get": { "summary": "Get grant by ID", "operationId": "/grant/{record_id}", "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "record_id": "ASC-25/26-070-C", "recipient_legal_name": "Canadian Standards Association", "department": "Accessibility Standards Canada", "agreement_value": 79365.0, "start_date": "2020-03-23" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/infrastructure_project/{record_id}": { "get": { "summary": "Get infrastructure project by ID", "operationId": "/infrastructure_project/{record_id}", "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "record_id": "ASC-25/26-070-C", "recipient_legal_name": "Canadian Standards Association", "department": "Accessibility Standards Canada", "agreement_value": 79365.0, "start_date": "2020-03-23" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/research_grant/{record_id}": { "get": { "summary": "Get research grant by ID", "operationId": "/research_grant/{record_id}", "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {}, "example": { "record_id": "ASC-25/26-070-C", "recipient_legal_name": "Canadian Standards Association", "department": "Accessibility Standards Canada", "agreement_value": 79365.0, "start_date": "2020-03-23" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } }, "servers": [ { "url": "https://hv1nforwhi.execute-api.ca-central-1.amazonaws.com" } ] }