Buscar Modelos

Tabela de Parâmetros

Nome do Parâmetro	Obrigatório	Tipo	Descrição
*page	sim	int	Página a ser exibida
*per_page	sim	int	Quantas previsões serão exibidas por página
id	não	int	ID do modelo
name	não	str (icontains)	Nome do modelo
author_name	não	str (icontains)	Nome do autor
author_username	não	str	Nome de usuário do autor
author_institution	não	str (icontains)	Instituição do autor
repository	não	str (icontains)	Repositório Github
implementation_language	não	str (icontains)	Linguagem de implementação
temporal	não	bool	O modelo é temporal?
spatial	não	bool	O modelo é espacial?
categorical	não	bool	O modelo é categórico?
type	não	str (icontains)	Tipo de modelo. Ex: nowcast / forecast
adm_level	não	int (0, 1, 2 ou 3)	Nível administrativo, opções: 0, 1, 2, 3 (Nacional, Estadual, Municipal, Submunicipal)
time_resolution	não	str (iexact)	Opções: dia, semana, mês ou ano

Detalhes

page consiste no total de modelos retornados pela requisição dividido por per_page. A informação de pagination é retornada junto com os modelos. Ex.:

'pagination': {
    'items': 10,                    # Quantidade de Modelos sendo exibidos 
    'total_items': 10,          # Quantidade total de Modelos retornados na requisição
    'page': 1,                       # *parâmetro da requisição
    'total_pages': 1,           # Quantidade total de páginas retornadas na requisição
    'per_page': 50              # *parâmetro da requisição
},

Exemplos de uso

Os exemplos em Python utilizam o pacote mosqlient, especificamente desenvolvido para interagir com a API. Para mais informações sobre como utilizá-lo, consulte a documentação aqui.

Python3Rcurl

import mosqlient

# List all Models
mosqlient.get_all_models(X-UID-Key)

# get specific Model
mosqlient.get_model_by_id(X-UID-Key, id)

# get models with filters
mosqlient.get_models(X-UID-Key, **kwargs)

library(httr)
library(jsonlite)

models_api <- "https://api.mosqlimate.org/api/registry/models/"
headers <- add_headers(
  `X-UID-Key` = X-UID-Key
)

page <- 1
per_page <- 5
pagination <- paste0("?page=", page, "&per_page=", per_page, "&")

# List all Models
response_all <- GET(paste0(models_api, pagination), headers)
all_models <- content(response_all, "text") |> fromJSON()

# Get specific Model
response_specific <- GET(paste0(models_api, "1"), headers) # Model id
specific_model <- content(response_specific, "text") |> fromJSON()

# Filter by implementation language
response_python <- GET(paste0(models_api, pagination, "implementation_language=python"), headers)
models_python <- content(response_python, "text") |> fromJSON()

# Combining filters
filters_combined <- paste0("implementation_language=python", "&", "name=test")
response_combined <- GET(paste0(models_api, pagination, filters_combined),headers)
models_multi_filters <- content(response_combined, "text") |> fromJSON()

# Advanced Usage
parameters <- list(
  page = 1,
  per_page = 2
  # Add parameters here
)

get_models <- function(parameters) {
  models_api <- "https://api.mosqlimate.org/api/registry/models/?"
  parameters_url <- paste0(names(parameters), "=", unlist(parameters), collapse = "&")
  response <- GET(paste0(models_api, parameters_url), headers)
  models <- content(response, "text") |> fromJSON()
  return(models)
}

get_models(parameters)

# List all models
curl -X 'GET' \
  'https://api.mosqlimate.org/api/registry/models/?page=1&per_page=5' \
  -H 'accept: application/json' \
  -H 'X-UID-Key: See X-UID-Key documentation'

# Get specific Model
curl -X 'GET' \
  'https://api.mosqlimate.org/api/registry/models/1' \ # Model id
  -H 'accept: application/json' \
  -H 'X-UID-Key: See X-UID-Key documentation'

# Filter by implementation language
curl -X 'GET' \
  'https://api.mosqlimate.org/api/registry/models/?implementation_language=python&page=1&per_page=5' \
  -H 'accept: application/json' \
  -H 'X-UID-Key: See X-UID-Key documentation'

# Combining filters
curl -X 'GET' \
  'https://api.mosqlimate.org/api/registry/models/?id=1&name=test&implementation_language=python&page=1&per_page=5' \
  -H 'accept: application/json' \
  -H 'X-UID-Key: See X-UID-Key documentation'