metro-sp-api

KO | EN

gitlite — search

#javascript #deep-learning #react #python #hacktoberfest #nodejs #docker #kubernetes #java #json #computer-vision #linux

★ 19 Open GitHub ↗

Simple API to get status from all subway lines (Metrô, CPTM, Via Quatro and Via Mobilidade) from Sao Paulo Brazil

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Status Metro (API)

Just a simple API to get the last status from all subway lines (Metrô, CPTM, Via Quatro, and Via Mobilidade) in São Paulo

## Setup

With node (greater or equal to 18)
- `yarn` install packages
- `yarn start` start http server on port 5000

With docker (don't require node)
- `docker build . -t metro-sp-api` to build docker image
- `docker run -p 5001:5000 -d whatever/metro-sp-api` run docker image at port 5001 (you can specify other por than 5001)

## Usage

`GET http://localhost:5000`

### Response example:

```json
{
  "lines": [
    {
      "name": "Linha 1 - Azul",
      "number": "1",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "Linha 2 - Verde",
      "number": "2",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "Linha 3 - Vermelha",
      "number": "3",
      "reason": "Devido à Interferência na via entre as estações CARRÃO ASSAÍ ATACADISTA e PENHA, circulação com velocidade reduzida e maior tempo de parada. Estamos trabalhando para a normalização.",
      "statusDescription": "Velocidade Reduzida",
      "status": "reduced_speed"
    },
    {
      "name": "Linha 4-Amarela",
      "number": "4",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "Linha 5-Lilás",
      "number": "5",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "RUBI",
      "number": "7",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "Linha 8-Diamante",
      "number": "8",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "Linha 9-Esmeralda",
      "number": "9",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "TURQUESA",
      "number": "10",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "CORAL",
      "number": "11",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "SAFIRA",
      "number": "12",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "JADE",
      "number": "13",
      "statusDescription": "Operação Normal",
      "status": "normal"
    },
    {
      "name": "Linha 15 - Prata",
      "number": "15",
      "statusDescription": "Operação Normal",
      "status": "normal"
    }
  ],
  "updatedAt": "2023-03-25T22:27:24.000Z"
}
```

### Available Statuses

- normal: All fine (Operação Normal)
- reduced_speed: Trains are going slow on this line (Velocidade reduzida)
- closed: Line is closed (out of operation hours) (Operação encerrada)
- paralyzed: All trains are stopped on this line (Operação paralizada)

metro-sp-api

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README