Mosqlimate API 1¶
Welcome to Mosqlimate API Reference
In API Demo, you can test the API calls to Mosqlimate's Platform. Note that the POST calls won't save any result in the database.
See API Overview to more detailed information about the endpoints.
registry¶
GET /api/registry/authors/¶
List Authors
Description
Lists all authors, can be filtered by name. Authors that don't have any Model won't be listed
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
institution |
query | string | No | Author's association | |
name |
query | string | No | Author's full name | |
page |
query | integer | 1 | No | |
per_page |
query | integer | 300 | No | |
username |
query | string | No | Author's username |
Response 200 OK
{
"items": [
{
"user": {
"name": null,
"username": "string"
},
"institution": null
}
],
"pagination": null,
"message": null,
"error": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/AuthorSchema"
},
"title": "Items",
"type": "array"
},
"pagination": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Pagination"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"required": [
"items"
],
"title": "PagedAuthorSchema",
"type": "object"
}
GET /api/registry/authors/{username}¶
Get Author
Description
Gets author by Github username
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
username |
path | string | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"user": {
"$ref": "#/components/schemas/UserSchema"
},
"institution": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Author's association",
"title": "Institution"
}
},
"required": [
"user"
],
"title": "AuthorSchema",
"type": "object"
}
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/registry/models/¶
List Models
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ADM_level |
query | None | No | Administrative level. Country, State, Municipality and SubMunicipality respectively | |
author_institution |
query | None | No | Model's Author association | |
author_name |
query | None | No | Model's Author full name | |
author_username |
query | None | No | Model's Author username | |
categorical |
query | None | No | ||
disease |
query | None | No | Model for disease | |
id |
query | None | No | Model ID | |
implementation_language |
query | None | No | Model implementation language | |
name |
query | None | No | Model name | |
page |
query | integer | 1 | No | |
per_page |
query | integer | 300 | No | |
repository |
query | None | No | Model git repository | |
spatial |
query | None | No | ||
sprint |
query | None | No | Model for Sprint 2024/25 | |
tags |
query | None | No | List of Model tags | |
temporal |
query | None | No | ||
time_resolution |
query | None | No | Time resolution. Options: 'day', 'week', 'month' or 'year' |
Response 200 OK
{
"items": [
{
"id": null,
"name": "string",
"description": "string",
"author": {
"user": {
"name": null,
"username": "string"
},
"institution": null
},
"repository": "string",
"implementation_language": {
"language": "string"
},
"disease": "dengue",
"categorical": null,
"spatial": null,
"temporal": null,
"ADM_level": 0,
"time_resolution": "day",
"sprint": true
}
],
"pagination": null,
"message": null,
"error": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ModelSchema"
},
"title": "Items",
"type": "array"
},
"pagination": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Pagination"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"required": [
"items"
],
"title": "PagedModelSchema",
"type": "object"
}
POST /api/registry/models/¶
Create Model
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
UidKeyAuth |
header | string | N/A | No | API key |
Request body
{
"name": "string",
"description": "string",
"repository": "string",
"implementation_language": "string",
"disease": "dengue",
"temporal": true,
"spatial": true,
"categorical": true,
"ADM_level": 0,
"time_resolution": "day",
"sprint": true
}
Schema of the request body
{
"properties": {
"name": {
"description": "Model name",
"title": "Name",
"type": "string"
},
"description": {
"description": "Model description",
"title": "Description",
"type": "string"
},
"repository": {
"default": "https://github.com/",
"description": "Model git repository",
"title": "Repository",
"type": "string"
},
"implementation_language": {
"default": "python",
"description": "Model implementation programming language",
"title": "Implementation Language",
"type": "string"
},
"disease": {
"default": "dengue",
"description": "Model for disease",
"enum": [
"dengue",
"zika",
"chikungunya"
],
"title": "Disease",
"type": "string"
},
"temporal": {
"title": "Temporal",
"type": "boolean"
},
"spatial": {
"title": "Spatial",
"type": "boolean"
},
"categorical": {
"title": "Categorical",
"type": "boolean"
},
"ADM_level": {
"default": 0,
"description": "Administrative level. Country, State, Municipality and SubMunicipality respectively",
"enum": [
0,
1,
2,
3
],
"title": "Adm Level",
"type": "integer"
},
"time_resolution": {
"default": "week",
"description": "Time resolution. Options: 'day', 'week', 'month' or 'year'",
"enum": [
"day",
"week",
"month",
"year"
],
"title": "Time Resolution",
"type": "string"
},
"sprint": {
"default": false,
"description": "Model for Sprint 2024/25",
"title": "Sprint",
"type": "boolean"
}
},
"required": [
"name",
"description",
"temporal",
"spatial",
"categorical"
],
"title": "ModelIn",
"type": "object"
}
Response 201 Created
{
"id": null,
"name": "string",
"description": "string",
"author": {
"user": {
"name": null,
"username": "string"
},
"institution": null
},
"repository": "string",
"implementation_language": {
"language": "string"
},
"disease": "dengue",
"categorical": null,
"spatial": null,
"temporal": null,
"ADM_level": 0,
"time_resolution": "day",
"sprint": true
}
Schema of the response body
{
"properties": {
"id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"description": "Model ID",
"title": "Id"
},
"name": {
"description": "Model name",
"title": "Name",
"type": "string"
},
"description": {
"description": "Model description",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"author": {
"$ref": "#/components/schemas/AuthorSchema"
},
"repository": {
"default": "https://github.com/",
"description": "Model git repository",
"title": "Repository",
"type": "string"
},
"implementation_language": {
"$ref": "#/components/schemas/ImplementationLanguageSchema"
},
"disease": {
"default": "dengue",
"description": "Model for disease",
"enum": [
"dengue",
"chikungunya",
"zika"
],
"title": "Disease",
"type": "string"
},
"categorical": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Categorical"
},
"spatial": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Spatial"
},
"temporal": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Temporal"
},
"ADM_level": {
"default": 0,
"description": "Administrative level. Country, State, Municipality and SubMunicipality respectively",
"enum": [
0,
1,
2,
3
],
"title": "Adm Level",
"type": "integer"
},
"time_resolution": {
"default": "week",
"description": "Time resolution. Options: 'day', 'week', 'month' or 'year'",
"enum": [
"day",
"week",
"month",
"year"
],
"title": "Time Resolution",
"type": "string"
},
"sprint": {
"default": false,
"description": "Model for Sprint 2024/25",
"title": "Sprint",
"type": "boolean"
}
},
"required": [
"name",
"description",
"author",
"implementation_language"
],
"title": "ModelSchema",
"type": "object"
}
Response 403 Forbidden
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 422 Unprocessable Entity
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/registry/models/{model_id}¶
Get Model
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
model_id |
path | integer | No |
Response 200 OK
{
"id": null,
"name": "string",
"description": "string",
"author": {
"user": {
"name": null,
"username": "string"
},
"institution": null
},
"repository": "string",
"implementation_language": {
"language": "string"
},
"disease": "dengue",
"categorical": null,
"spatial": null,
"temporal": null,
"ADM_level": 0,
"time_resolution": "day",
"sprint": true
}
Schema of the response body
{
"properties": {
"id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"description": "Model ID",
"title": "Id"
},
"name": {
"description": "Model name",
"title": "Name",
"type": "string"
},
"description": {
"description": "Model description",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"author": {
"$ref": "#/components/schemas/AuthorSchema"
},
"repository": {
"default": "https://github.com/",
"description": "Model git repository",
"title": "Repository",
"type": "string"
},
"implementation_language": {
"$ref": "#/components/schemas/ImplementationLanguageSchema"
},
"disease": {
"default": "dengue",
"description": "Model for disease",
"enum": [
"dengue",
"chikungunya",
"zika"
],
"title": "Disease",
"type": "string"
},
"categorical": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Categorical"
},
"spatial": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Spatial"
},
"temporal": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Temporal"
},
"ADM_level": {
"default": 0,
"description": "Administrative level. Country, State, Municipality and SubMunicipality respectively",
"enum": [
0,
1,
2,
3
],
"title": "Adm Level",
"type": "integer"
},
"time_resolution": {
"default": "week",
"description": "Time resolution. Options: 'day', 'week', 'month' or 'year'",
"enum": [
"day",
"week",
"month",
"year"
],
"title": "Time Resolution",
"type": "string"
},
"sprint": {
"default": false,
"description": "Model for Sprint 2024/25",
"title": "Sprint",
"type": "boolean"
}
},
"required": [
"name",
"description",
"author",
"implementation_language"
],
"title": "ModelSchema",
"type": "object"
}
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/registry/models/{model_id}¶
Delete Model
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
UidKeyAuth |
header | string | N/A | No | API key |
model_id |
path | integer | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 403 Forbidden
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/registry/predictions/¶
List Predictions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
adm_1_geocode |
query | None | No | Adm 1 geocode. Example: 33 | |
adm_2_geocode |
query | None | No | Adm 2 geocode. Example: 3304557 | |
author_institution |
query | None | No | Author institution | |
author_name |
query | None | No | Author name | |
author_username |
query | None | No | Author username | |
categorical |
query | None | No | ||
commit |
query | None | No | Repository commit hash | |
end |
query | None | No | Prediction end date. Format: 'YYYY-mm-dd' | |
id |
query | None | No | Prediction ID | |
implementation_language |
query | None | No | Model implementation language. Example: 'python' | |
model_ADM_level |
query | None | No | Model administrative level | |
model_disease |
query | None | No | Model disease. | |
model_id |
query | None | No | Model ID | |
model_name |
query | None | No | Model name | |
model_time_resolution |
query | None | No | Model time resolution | |
page |
query | integer | 1 | No | |
per_page |
query | integer | 300 | No | |
predict_date |
query | None | No | Prediction's predict date. Format: 'YYYY-mm-dd' | |
repository |
query | None | No | Model repository | |
spatial |
query | None | No | ||
sprint |
query | None | No | Prediction for Sprint 2024/25 | |
start |
query | None | No | Prediction start date. Format: 'YYYY-mm-dd' | |
tags |
query | None | No | List of Tag IDs | |
temporal |
query | None | No |
Response 200 OK
{
"items": [
{
"message": null,
"id": null,
"model": null,
"description": "string",
"commit": "string",
"predict_date": "2022-04-13",
"adm_0": "string",
"adm_1": null,
"adm_2": null,
"adm_3": null,
"data": [
{
"date": "2022-04-13",
"pred": 10.12,
"lower_95": null,
"lower_90": 10.12,
"lower_80": null,
"lower_50": null,
"upper_50": null,
"upper_80": null,
"upper_90": 10.12,
"upper_95": null
}
]
}
],
"pagination": null,
"message": null,
"error": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PredictionOut"
},
"title": "Items",
"type": "array"
},
"pagination": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Pagination"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"required": [
"items"
],
"title": "PagedPredictionOut",
"type": "object"
}
POST /api/registry/predictions/¶
Create Prediction
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
UidKeyAuth |
header | string | N/A | No | API key |
Request body
{
"model": 0,
"description": "string",
"commit": "string",
"predict_date": "2022-04-13",
"adm_0": "string",
"adm_1": null,
"adm_2": null,
"adm_3": null,
"prediction": [
{
"date": "2022-04-13",
"pred": 10.12,
"lower_95": 10.12,
"lower_90": 10.12,
"lower_80": 10.12,
"lower_50": 10.12,
"upper_50": 10.12,
"upper_80": 10.12,
"upper_90": 10.12,
"upper_95": 10.12
}
]
}
Schema of the request body
{
"properties": {
"model": {
"title": "Model",
"type": "integer"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"commit": {
"title": "Commit",
"type": "string"
},
"predict_date": {
"format": "date",
"title": "Predict Date",
"type": "string"
},
"adm_0": {
"default": "BRA",
"title": "Adm 0",
"type": "string"
},
"adm_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Adm 1"
},
"adm_2": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Adm 2"
},
"adm_3": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Adm 3"
},
"prediction": {
"items": {
"$ref": "#/components/schemas/PredictionDataRowSchema"
},
"title": "Prediction",
"type": "array"
}
},
"required": [
"model",
"commit",
"predict_date",
"prediction"
],
"title": "PredictionIn",
"type": "object"
}
Response 201 Created
{
"message": null,
"id": null,
"model": null,
"description": "string",
"commit": "string",
"predict_date": "2022-04-13",
"adm_0": "string",
"adm_1": null,
"adm_2": null,
"adm_3": null,
"data": [
{
"date": "2022-04-13",
"pred": 10.12,
"lower_95": null,
"lower_90": 10.12,
"lower_80": null,
"lower_50": null,
"upper_50": null,
"upper_80": null,
"upper_90": 10.12,
"upper_95": null
}
]
}
Schema of the response body
{
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Id"
},
"model": {
"anyOf": [
{
"$ref": "#/components/schemas/ModelSchema"
},
{
"type": "integer"
}
],
"title": "Model"
},
"description": {
"title": "Description",
"type": "string"
},
"commit": {
"title": "Commit",
"type": "string"
},
"predict_date": {
"format": "date",
"title": "Predict Date",
"type": "string"
},
"adm_0": {
"default": "BRA",
"title": "Adm 0",
"type": "string"
},
"adm_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Adm 1"
},
"adm_2": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Adm 2"
},
"adm_3": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Adm 3"
},
"data": {
"items": {
"$ref": "#/components/schemas/PredictionDataRowOut"
},
"title": "Data",
"type": "array"
}
},
"required": [
"model",
"description",
"commit",
"predict_date",
"data"
],
"title": "PredictionOut",
"type": "object"
}
Response 403 Forbidden
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 422 Unprocessable Entity
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 500 Internal Server Error
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/registry/predictions/{predict_id}¶
Get Prediction
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
predict_id |
path | integer | No |
Response 200 OK
{
"message": null,
"id": null,
"model": null,
"description": "string",
"commit": "string",
"predict_date": "2022-04-13",
"adm_0": "string",
"adm_1": null,
"adm_2": null,
"adm_3": null,
"data": [
{
"date": "2022-04-13",
"pred": 10.12,
"lower_95": null,
"lower_90": 10.12,
"lower_80": null,
"lower_50": null,
"upper_50": null,
"upper_80": null,
"upper_90": 10.12,
"upper_95": null
}
]
}
Schema of the response body
{
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Id"
},
"model": {
"anyOf": [
{
"$ref": "#/components/schemas/ModelSchema"
},
{
"type": "integer"
}
],
"title": "Model"
},
"description": {
"title": "Description",
"type": "string"
},
"commit": {
"title": "Commit",
"type": "string"
},
"predict_date": {
"format": "date",
"title": "Predict Date",
"type": "string"
},
"adm_0": {
"default": "BRA",
"title": "Adm 0",
"type": "string"
},
"adm_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Adm 1"
},
"adm_2": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Adm 2"
},
"adm_3": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Adm 3"
},
"data": {
"items": {
"$ref": "#/components/schemas/PredictionDataRowOut"
},
"title": "Data",
"type": "array"
}
},
"required": [
"model",
"description",
"commit",
"predict_date",
"data"
],
"title": "PredictionOut",
"type": "object"
}
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/registry/predictions/{predict_id}¶
Delete Prediction
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
UidKeyAuth |
header | string | N/A | No | API key |
predict_id |
path | integer | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 403 Forbidden
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
datastore¶
GET /api/datastore/infodengue/¶
Get Infodengue
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
disease |
query | string | No | ||
end |
query | string | 2024-02-01 | No | |
geocode |
query | None | No | ||
page |
query | integer | 1 | No | |
per_page |
query | integer | 300 | No | |
start |
query | string | 2024-01-01 | No | |
uf |
query | None | No |
Response 200 OK
{
"items": [
{
"data_iniSE": "2022-04-13",
"SE": null,
"casos_est": null,
"casos_est_min": null,
"casos_est_max": null,
"casos": null,
"municipio_geocodigo": null,
"p_rt1": null,
"p_inc100k": null,
"Localidade_id": null,
"nivel": null,
"id": null,
"versao_modelo": null,
"Rt": null,
"municipio_nome": null,
"pop": null,
"tempmin": null,
"umidmax": null,
"receptivo": null,
"transmissao": null,
"nivel_inc": null,
"umidmed": null,
"umidmin": null,
"tempmed": null,
"tempmax": null,
"casprov": null,
"casprov_est": null,
"casprov_est_min": null,
"casprov_est_max": null,
"casconf": null
}
],
"pagination": null,
"message": null,
"error": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/HistoricoAlertaSchema"
},
"title": "Items",
"type": "array"
},
"pagination": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Pagination"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"required": [
"items"
],
"title": "PagedHistoricoAlertaSchema",
"type": "object"
}
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 500 Internal Server Error
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/datastore/climate/¶
Get Copernicus Brasil
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
end |
query | string | 2024-02-01 | No | |
geocode |
query | None | No | ||
page |
query | integer | 1 | No | |
per_page |
query | integer | 300 | No | |
start |
query | string | 2024-01-01 | No | |
uf |
query | None | No |
Response 200 OK
{
"items": [
{
"date": "2022-04-13",
"geocodigo": 0,
"epiweek": 0,
"temp_min": 10.12,
"temp_med": 10.12,
"temp_max": 10.12,
"precip_min": 10.12,
"precip_med": 10.12,
"precip_max": 10.12,
"precip_tot": 10.12,
"pressao_min": 10.12,
"pressao_med": 10.12,
"pressao_max": 10.12,
"umid_min": 10.12,
"umid_med": 10.12,
"umid_max": 10.12
}
],
"pagination": null,
"message": null,
"error": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/CopernicusBrasilSchema"
},
"title": "Items",
"type": "array"
},
"pagination": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Pagination"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"required": [
"items"
],
"title": "PagedCopernicusBrasilSchema",
"type": "object"
}
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 500 Internal Server Error
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/datastore/climate/weekly/¶
Get Copernicus Brasil Weekly
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
end |
query | integer | 202402 | No | |
geocode |
query | None | No | ||
macro_health_code |
query | None | No | ||
page |
query | integer | 1 | No | |
per_page |
query | integer | 300 | No | |
start |
query | integer | 202401 | No | |
uf |
query | None | No |
Response 200 OK
{
"items": [
{
"epiweek": 0,
"geocodigo": 0,
"temp_min_avg": 10.12,
"temp_med_avg": 10.12,
"temp_max_avg": 10.12,
"temp_amplit_avg": 10.12,
"precip_tot_sum": 10.12,
"umid_min_avg": 10.12,
"umid_med_avg": 10.12,
"umid_max_avg": 10.12
}
],
"pagination": null,
"message": null,
"error": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/CopernicusBrasilWeeklySchema"
},
"title": "Items",
"type": "array"
},
"pagination": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Pagination"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"required": [
"items"
],
"title": "PagedCopernicusBrasilWeeklySchema",
"type": "object"
}
Response 400 Bad Request
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 500 Internal Server Error
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/datastore/mosquito/¶
Get Contaovos
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
date_end |
query | string | 2025-01-30 | No | |
date_start |
query | string | 2025-01-01 | No | |
municipality |
query | None | No | ||
page |
query | None | 1 | No | |
state |
query | None | MG | No |
Response 200 OK
[
{
"counting_id": 0,
"date": "string",
"date_collect": null,
"eggs": 0,
"latitude": 10.12,
"longitude": 10.12,
"municipality": "string",
"municipality_code": "string",
"ovitrap_id": "string",
"ovitrap_website_id": 0,
"state_code": "string",
"state_name": "string",
"time": "string",
"week": 0,
"year": 0
}
]
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 500 Internal Server Error
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/datastore/episcanner/¶
Get Episcanner
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
disease |
query | string | No | ||
uf |
query | string | No | ||
year |
query | integer | 2025 | No |
Response 200 OK
[
{
"disease": "string",
"CID10": "string",
"year": 0,
"geocode": 0,
"muni_name": "string",
"peak_week": 10.12,
"beta": 10.12,
"gamma": 10.12,
"R0": 10.12,
"total_cases": 10.12,
"alpha": 10.12,
"sum_res": 10.12,
"ep_ini": "string",
"ep_end": "string",
"ep_dur": 0
}
]
Response 404 Not Found
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 500 Internal Server Error
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Endpoints¶
POST /api/vis/results-prob-forecast/¶
Post Results Prob Forecast
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
UidKeyAuth |
header | string | N/A | No | API key |
Request body
{
"disease": "dengue",
"date": "2022-04-13",
"geocode": 0,
"lower_2_5": 10.12,
"lower_25": 10.12,
"forecast": 10.12,
"upper_75": 10.12,
"upper_97_5": 10.12,
"prob_high": 10.12,
"prob_low": 10.12,
"high_threshold": 10.12,
"low_threshold": 10.12,
"high_incidence_threshold": 10.12,
"low_incidence_threshold": 10.12
}
Schema of the request body
{
"properties": {
"disease": {
"enum": [
"dengue",
"chik",
"chikungunya",
"zika"
],
"title": "Disease",
"type": "string"
},
"date": {
"format": "date",
"title": "Date",
"type": "string"
},
"geocode": {
"title": "Geocode",
"type": "integer"
},
"lower_2_5": {
"title": "Lower 2 5",
"type": "number"
},
"lower_25": {
"title": "Lower 25",
"type": "number"
},
"forecast": {
"title": "Forecast",
"type": "number"
},
"upper_75": {
"title": "Upper 75",
"type": "number"
},
"upper_97_5": {
"title": "Upper 97 5",
"type": "number"
},
"prob_high": {
"title": "Prob High",
"type": "number"
},
"prob_low": {
"title": "Prob Low",
"type": "number"
},
"high_threshold": {
"title": "High Threshold",
"type": "number"
},
"low_threshold": {
"title": "Low Threshold",
"type": "number"
},
"high_incidence_threshold": {
"title": "High Incidence Threshold",
"type": "number"
},
"low_incidence_threshold": {
"title": "Low Incidence Threshold",
"type": "number"
}
},
"required": [
"disease",
"date",
"geocode",
"lower_2_5",
"lower_25",
"forecast",
"upper_75",
"upper_97_5",
"prob_high",
"prob_low",
"high_threshold",
"low_threshold",
"high_incidence_threshold",
"low_incidence_threshold"
],
"title": "ResultsProbForecastSchema",
"type": "object"
}
Response 201 Created
{
"disease": "dengue",
"date": "2022-04-13",
"geocode": 0,
"lower_2_5": 10.12,
"lower_25": 10.12,
"forecast": 10.12,
"upper_75": 10.12,
"upper_97_5": 10.12,
"prob_high": 10.12,
"prob_low": 10.12,
"high_threshold": 10.12,
"low_threshold": 10.12,
"high_incidence_threshold": 10.12,
"low_incidence_threshold": 10.12
}
Schema of the response body
{
"properties": {
"disease": {
"enum": [
"dengue",
"chik",
"chikungunya",
"zika"
],
"title": "Disease",
"type": "string"
},
"date": {
"format": "date",
"title": "Date",
"type": "string"
},
"geocode": {
"title": "Geocode",
"type": "integer"
},
"lower_2_5": {
"title": "Lower 2 5",
"type": "number"
},
"lower_25": {
"title": "Lower 25",
"type": "number"
},
"forecast": {
"title": "Forecast",
"type": "number"
},
"upper_75": {
"title": "Upper 75",
"type": "number"
},
"upper_97_5": {
"title": "Upper 97 5",
"type": "number"
},
"prob_high": {
"title": "Prob High",
"type": "number"
},
"prob_low": {
"title": "Prob Low",
"type": "number"
},
"high_threshold": {
"title": "High Threshold",
"type": "number"
},
"low_threshold": {
"title": "Low Threshold",
"type": "number"
},
"high_incidence_threshold": {
"title": "High Incidence Threshold",
"type": "number"
},
"low_incidence_threshold": {
"title": "Low Incidence Threshold",
"type": "number"
}
},
"required": [
"disease",
"date",
"geocode",
"lower_2_5",
"lower_25",
"forecast",
"upper_75",
"upper_97_5",
"prob_high",
"prob_low",
"high_threshold",
"low_threshold",
"high_incidence_threshold",
"low_incidence_threshold"
],
"title": "ResultsProbForecastSchema",
"type": "object"
}
Response 403 Forbidden
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 422 Unprocessable Entity
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schemas¶
AuthorFilterSchema¶
| Name | Type |
|---|---|
institution |
string |
name |
string |
username |
string |
AuthorSchema¶
| Name | Type |
|---|---|
institution |
|
user |
UserSchema |
BadRequestSchema¶
| Name | Type |
|---|---|
message |
string |
ContaOvosParams¶
| Name | Type |
|---|---|
date_end |
string(date) |
date_start |
string(date) |
page |
|
state |
ContaOvosSchema¶
| Name | Type |
|---|---|
counting_id |
integer |
date |
string |
date_collect |
|
eggs |
integer |
latitude |
number |
longitude |
number |
municipality |
string |
municipality_code |
string |
ovitrap_id |
string |
ovitrap_website_id |
integer |
state_code |
string |
state_name |
string |
time |
string |
week |
integer |
year |
integer |
CopernicusBrasilFilterSchema¶
| Name | Type |
|---|---|
end |
string(date) |
geocode |
|
start |
string(date) |
CopernicusBrasilSchema¶
| Name | Type |
|---|---|
date |
string(date) |
epiweek |
integer |
geocodigo |
integer |
precip_max |
number |
precip_med |
number |
precip_min |
number |
precip_tot |
number |
pressao_max |
number |
pressao_med |
number |
pressao_min |
number |
temp_max |
number |
temp_med |
number |
temp_min |
number |
umid_max |
number |
umid_med |
number |
umid_min |
number |
CopernicusBrasilWeeklyFilterSchema¶
| Name | Type |
|---|---|
end |
integer |
start |
integer |
CopernicusBrasilWeeklyParams¶
| Name | Type |
|---|---|
geocode |
|
macro_health_code |
|
uf |
CopernicusBrasilWeeklySchema¶
| Name | Type |
|---|---|
epiweek |
integer |
geocodigo |
integer |
precip_tot_sum |
number |
temp_amplit_avg |
number |
temp_max_avg |
number |
temp_med_avg |
number |
temp_min_avg |
number |
umid_max_avg |
number |
umid_med_avg |
number |
umid_min_avg |
number |
EpiScannerSchema¶
| Name | Type |
|---|---|
alpha |
number |
beta |
number |
CID10 |
string |
disease |
string |
ep_dur |
integer |
ep_end |
string |
ep_ini |
string |
gamma |
number |
geocode |
integer |
muni_name |
string |
peak_week |
number |
R0 |
number |
sum_res |
number |
total_cases |
number |
year |
integer |
ForbiddenSchema¶
| Name | Type |
|---|---|
message |
string |
HistoricoAlertaFilterSchema¶
| Name | Type |
|---|---|
end |
string(date) |
geocode |
|
start |
string(date) |
HistoricoAlertaSchema¶
| Name | Type |
|---|---|
casconf |
|
casos |
|
casos_est |
|
casos_est_max |
|
casos_est_min |
|
casprov |
|
casprov_est |
|
casprov_est_max |
|
casprov_est_min |
|
data_iniSE |
string(date) |
id |
|
Localidade_id |
|
municipio_geocodigo |
|
municipio_nome |
|
nivel |
|
nivel_inc |
|
p_inc100k |
|
p_rt1 |
|
pop |
|
receptivo |
|
Rt |
|
SE |
|
tempmax |
|
tempmed |
|
tempmin |
|
transmissao |
|
umidmax |
|
umidmed |
|
umidmin |
|
versao_modelo |
ImplementationLanguageSchema¶
| Name | Type |
|---|---|
language |
string |
Input¶
| Name | Type |
|---|---|
page |
integer |
per_page |
integer |
InternalErrorSchema¶
| Name | Type |
|---|---|
message |
string |
ModelFilterSchema¶
| Name | Type |
|---|---|
ADM_level |
|
author_institution |
|
author_name |
|
author_username |
|
categorical |
|
disease |
|
id |
|
implementation_language |
|
name |
|
repository |
|
spatial |
|
sprint |
|
tags |
|
temporal |
|
time_resolution |
ModelIn¶
| Name | Type |
|---|---|
ADM_level |
integer |
categorical |
boolean |
description |
string |
disease |
string |
implementation_language |
string |
name |
string |
repository |
string |
spatial |
boolean |
sprint |
boolean |
temporal |
boolean |
time_resolution |
string |
ModelSchema¶
| Name | Type |
|---|---|
ADM_level |
integer |
author |
AuthorSchema |
categorical |
|
description |
string |
disease |
string |
id |
|
implementation_language |
ImplementationLanguageSchema |
name |
string |
repository |
string |
spatial |
|
sprint |
boolean |
temporal |
|
time_resolution |
string |
NotFoundSchema¶
| Name | Type |
|---|---|
message |
string |
PagedAuthorSchema¶
| Name | Type |
|---|---|
error |
|
items |
Array<AuthorSchema> |
message |
|
pagination |
PagedCopernicusBrasilSchema¶
| Name | Type |
|---|---|
error |
|
items |
Array<CopernicusBrasilSchema> |
message |
|
pagination |
PagedCopernicusBrasilWeeklySchema¶
| Name | Type |
|---|---|
error |
|
items |
Array<CopernicusBrasilWeeklySchema> |
message |
|
pagination |
PagedHistoricoAlertaSchema¶
| Name | Type |
|---|---|
error |
|
items |
Array<HistoricoAlertaSchema> |
message |
|
pagination |
PagedModelSchema¶
| Name | Type |
|---|---|
error |
|
items |
Array<ModelSchema> |
message |
|
pagination |
PagedPredictionOut¶
| Name | Type |
|---|---|
error |
|
items |
Array<PredictionOut> |
message |
|
pagination |
PredictionDataRowOut¶
| Name | Type |
|---|---|
date |
string(date) |
lower_50 |
|
lower_80 |
|
lower_90 |
number |
lower_95 |
|
pred |
number |
upper_50 |
|
upper_80 |
|
upper_90 |
number |
upper_95 |
PredictionDataRowSchema¶
| Name | Type |
|---|---|
date |
string(date) |
lower_50 |
number |
lower_80 |
number |
lower_90 |
number |
lower_95 |
number |
pred |
number |
upper_50 |
number |
upper_80 |
number |
upper_90 |
number |
upper_95 |
number |
PredictionFilterSchema¶
| Name | Type |
|---|---|
adm_1_geocode |
|
adm_2_geocode |
|
author_institution |
|
author_name |
|
author_username |
|
categorical |
|
commit |
|
end |
|
id |
|
implementation_language |
|
model_ADM_level |
|
model_disease |
|
model_id |
|
model_name |
|
model_time_resolution |
|
predict_date |
|
repository |
|
spatial |
|
sprint |
|
start |
|
tags |
|
temporal |
PredictionIn¶
| Name | Type |
|---|---|
adm_0 |
string |
adm_1 |
|
adm_2 |
|
adm_3 |
|
commit |
string |
description |
string |
model |
integer |
predict_date |
string(date) |
prediction |
Array<PredictionDataRowSchema> |
PredictionOut¶
| Name | Type |
|---|---|
adm_0 |
string |
adm_1 |
|
adm_2 |
|
adm_3 |
|
commit |
string |
data |
Array<PredictionDataRowOut> |
description |
string |
id |
|
message |
|
model |
|
predict_date |
string(date) |
ResultsProbForecastSchema¶
| Name | Type |
|---|---|
date |
string(date) |
disease |
string |
forecast |
number |
geocode |
integer |
high_incidence_threshold |
number |
high_threshold |
number |
low_incidence_threshold |
number |
low_threshold |
number |
lower_25 |
number |
lower_2_5 |
number |
prob_high |
number |
prob_low |
number |
upper_75 |
number |
upper_97_5 |
number |
SuccessSchema¶
| Name | Type |
|---|---|
message |
UnprocessableContentSchema¶
| Name | Type |
|---|---|
message |
string |
UserSchema¶
| Name | Type |
|---|---|
name |
|
username |
string |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| UidKeyAuth | apiKey |