{"openapi":"3.0.0","info":{"title":"OlhoVivo","version":"v2.1","description":"A API do Olho Vivo fornece informações em tempo real do monitoramento da frota de ônibus da cidade de São Paulo. Dúvidas/reclamações deverão ser realizadas através do SP156: https://sp156.prefeitura.sp.gov.br/portal/servicos/informacao?servico=1010","contact":{"name":"SPTrans","url":"http://www.sptrans.com.br/desenvolvedores/"}},"tags":[{"name":"Linhas","description":"A categoria Linhas possibilita a consulta pelas linhas de ônibus da cidade de São Paulo, bem como suas informações cadastrais como por exemplo: horário de operação da linha, dias de operação (dia útil, sábado ou domingo) e extensão da linha (em metros).","externalDocs":{"url":"http://sptrans.com.br/desenvolvedores/api-do-olho-vivo-guia-de-referencia/documentacao-api/"}},{"name":"Paradas","description":"A categoria Paradas possibilita a consulta pelos pontos de parada da cidade de São Paulo. Atualmente esta categoria contempla apenas as paradas de corredores.","externalDocs":{"url":"http://sptrans.com.br/desenvolvedores/api-do-olho-vivo-guia-de-referencia/documentacao-api/"}},{"name":"Corredores","description":"A categoria Corredores possibilita uma consulta que retorna todos os corredores inteligentes da cidade de São Paulo.","externalDocs":{"url":"http://sptrans.com.br/desenvolvedores/api-do-olho-vivo-guia-de-referencia/documentacao-api/"}},{"name":"Empresas","description":"A categoria Empresas possibilita uma consulta que retorna a relação das empresas operadoras do transporte público na cidade de São Paulo.","externalDocs":{"url":"http://sptrans.com.br/desenvolvedores/api-do-olho-vivo-guia-de-referencia/documentacao-api/"}},{"name":"PosicaoDosVeiculos","description":"A categoria Posição Dos Veículos é a responsável por retornar a posição exata de cada veículo de qualquer linha de ônibus da SPTrans","externalDocs":{"url":"http://sptrans.com.br/desenvolvedores/api-do-olho-vivo-guia-de-referencia/documentacao-api/"}},{"name":"PrevisaoDeChegada","description":"A categoria Previsão de chegada é a responsável por retornar a previsão de chegada de cada veículo de uma determinada linha e de um determinado ponto de parada, além da localização exata de cada veículo que constar na cadeia de previsões. Obs.: As previsões são baseadas no horário também informado no retorno dos métodos.","externalDocs":{"url":"http://sptrans.com.br/desenvolvedores/api-do-olho-vivo-guia-de-referencia/documentacao-api/"}}],"paths":{"/Linha/Buscar":{"get":{"parameters":[{"in":"query","name":"termosBusca","required":true,"schema":{"type":"string"},"description":"Aceita denominação ou número da linha (total ou parcial). Exemplo: 8000, Lapa ou Ramos"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linha"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Realiza uma busca das linhas do sistema com base no parâmetro informado.","description":"Se a linha não é encontrada então é realizada uma busca fonetizada na denominação das linhas.","tags":["Linhas"]}},"/Linha/BuscarLinhaSentido":{"get":{"parameters":[{"$ref":"#/components/parameters/termosBusca"},{"$ref":"#/components/parameters/sentido"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linha"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Realiza uma busca das linhas do sistema com base no parâmetro informado.","description":"Se a linha não é encontrada então é realizada uma busca fonetizada na denominação das linhas. A linha retornada será unicamente aquela cujo sentido de operação seja o informado no parâmetro 'sentido'.","tags":["Linhas"]}},"/Parada/Buscar":{"get":{"parameters":[{"$ref":"#/components/parameters/termosBusca"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parada"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Realiza uma busca fonética das paradas de ônibus do sistema com base no parâmetro informado.","description":"A consulta é realizada no nome da parada e também no seu endereço de localização.","tags":["Paradas"]}},"/Parada/BuscarParadasPorLinha":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoLinha"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parada"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Realiza uma busca por todos os pontos de parada atendidos por uma determinada linha.","description":"A consulta é realizada pelo código da linha.","tags":["Paradas"]}},"/Parada/BuscarParadasPorCorredor":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoCorredor"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parada"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna a lista detalhada de todas as paradas que compõem um determinado corredor.","description":"A consulta é realizada pelo código do corredor.","tags":["Paradas"]}},"/Corredor":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Corredor"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista com todos os corredores inteligentes.","description":"Não há parâmetros de entrada.","tags":["Corredores"]}},"/Empresa":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empresa"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista com todos as empresas operadoras relacionadas por área de operação","description":"Não há parâmetros de entrada.","tags":["Empresas"]}},"/Posicao":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Posicao"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista completa com a última localização de todos os veículos mapeados com suas devidas posições lat / long","description":"Não há parâmetros de entrada","tags":["PosicaoDosVeiculos"]}},"/Posicao/Linha":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoLinha"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosicaoVeiculos"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista com todos os veículos de uma determinada linha com suas devidas posições lat / long","description":"Não há parâmetros de entrada","tags":["PosicaoDosVeiculos"]}},"/Posicao/Garagem":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoEmpresa"},{"$ref":"#/components/parameters/codigoLinha"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosicaoGaragem"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista completa de todos os veículos mapeados que estejam transmitindo em uma garagem da empresa informada.","description":"Não há parâmetros de entrada","tags":["PosicaoDosVeiculos"]}},"/Previsao":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoParada"},{"$ref":"#/components/parameters/codigoLinha"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrevisaoChegada"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista com a previsão de chegada dos veículos da linha informada que atende ao ponto de parada informado.","description":"A consulta é realizada usando o código da parada e o código da linha","tags":["PrevisaoDeChegada"]}},"/Previsao/Linha":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoLinha"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrevisaoChegadaLinha"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista com a previsão de chegada de cada um dos veículos da linha informada em todos os pontos de parada aos quais que ela atende.","description":"A consulta é realizada utilizando o código da linha.","tags":["PrevisaoDeChegada"]}},"/Previsao/Parada":{"get":{"parameters":[{"$ref":"#/components/parameters/codigoParada"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrevisaoChegada"}}}}},"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","summary":"Retorna uma lista com a previsão de chegada dos veículos de cada uma das linhas que atendem ao ponto de parada informado.","description":"A consulta é realizada utilizando o código da parada.","tags":["PrevisaoDeChegada"]}}},"components":{"parameters":{"termosBusca":{"in":"query","name":"termosBusca","required":true,"schema":{"type":"string"},"description":"Aceita denominação ou número da linha (total ou parcial). Exemplo: 8000, Lapa ou Ramos"},"sentido":{"in":"query","name":"sentido","required":true,"schema":{"type":"integer"},"description":"Código identificador do sentido de operação da linha, onde:<br>\n<ul>\n  <li>1 - Terminal Principal para Terminal Secundário;</li>\n  <li>2 - Terminal Secundário para Terminal Principal</li>\n</ul\n"},"codigoLinha":{"in":"query","name":"codigoLinha","required":true,"schema":{"type":"integer"},"description":"Código identificador da linha. Este é um código identificador único de cada linha do sistema (por sentido) e pode ser obtido através do método BUSCAR da categoria Linhas. Exemplo: 1273"},"codigoCorredor":{"in":"query","name":"codigoCorredor","required":true,"schema":{"type":"integer"},"description":"Código identificador do corredor. Este é um código identificador único de cada corredor do sistema e pode ser obtido através do método GET da categoria Corredores. Exemplo: 8"},"codigoEmpresa":{"in":"query","name":"codigoEmpresa","required":true,"schema":{"type":"integer"},"description":"Código identificador da empresa. Este é um código identificador único que pode ser obtido através do método GET da categoria Empresas. Exemplo: 999"},"codigoParada":{"in":"query","name":"codigoParada","required":true,"schema":{"type":"integer"},"description":"Código identificador da parada. Este é um código identificador único de cada ponto de parada do sistema (por sentido) e pode ser obtido através do método BUSCAR da categoria Paradas. Exemplo: 340015329"}},"schemas":{"Linha":{"type":"object","properties":{"cl":{"type":"integer","description":"Código identificador da linha. Este é um código identificador único de cada linha do sistema (por sentido de operação)","example":1273},"lc":{"type":"boolean","description":"Indica se uma linha opera no modo circular (sem um terminal secundário)","example":false},"lt":{"type":"string","description":"Informa a primeira parte do letreiro numérico da linha","example":"8000"},"tl":{"type":"integer","description":"Informa a segunda parte do letreiro numérico da linha, que indica se a linha opera nos modos: BASE (10), ATENDIMENTO (21, 23, 32, 41)","example":10},"sl":{"type":"integer","description":"Informa o sentido ao qual a linha atende, onde 1 significa Terminal Principal para Terminal Secundário e 2 para Terminal Secundário para Terminal Principal","example":1},"tp":{"type":"string","description":"Informa o letreiro descritivo da linha no sentido Terminal Principal para Terminal Secundário","example":"PCA.RAMOS DE AZEVEDO"},"ts":{"type":"string","description":"Informa o letreiro descritivo da linha no sentido Terminal Secundário para Terminal Principal","example":"TERMINAL LAPA"}}},"Parada":{"type":"object","properties":{"cp":{"type":"integer","description":"Código identificador da parada","example":340015329},"np":{"type":"string","description":"Nome da parada","example":"AFONSO BRAZ B/C1"},"ed":{"type":"string","description":"Endereço de localização da parada","example":"R ARMINDA/ R BALTHAZAR DA VEIGA"},"py":{"type":"number","format":"double","description":"Informação de latitude da localização da parada","example":-23.592938},"px":{"type":"number","format":"double","description":"Informação de longitude da localização da parada","example":-46.672727}}},"Corredor":{"type":"object","properties":{"cc":{"type":"integer","description":"Código identificador do corredor. Este é um código identificador único de cada corredor inteligente do sistema","example":8},"nc":{"type":"string","description":"Nome do corredor","example":"Campo Limpo"}}},"Empresa":{"type":"object","properties":{"hr":{"type":"string","description":"Horário de referência da geração das informações","example":"11:20"},"e":{"type":"object","description":"Relação de empresas por área de operação","properties":{"a":{"type":"integer","description":"Código da área de operação"},"e":{"type":"object","description":"Relação de empresas","properties":{"a":{"type":"integer","description":"Código da área de operação"},"c":{"type":"integer","description":"Código de referência da empresa"},"n":{"type":"string","description":"Nome da empresa"}}}}}}},"Posicao":{"type":"object","properties":{"hr":{"type":"string","description":"Horário de referência da geração das informações","example":"11:30"},"content":{"$ref":"#/components/schemas/l"}}},"PosicaoVeiculos":{"type":"object","properties":{"hr":{"type":"string","description":"Horário de referência da geração das informações","example":"19:57"},"content":{"$ref":"#/components/schemas/vs"}}},"PosicaoGaragem":{"type":"object","properties":{"hr":{"type":"string","description":"Horário de referência da geração das informações","example":"11:30"},"content":{"$ref":"#/components/schemas/l"}}},"PrevisaoChegada":{"type":"object","properties":{"hr":{"type":"string","description":"Horário de referência da geração das informações","example":"20:09"},"p":{"type":"object","description":"Representa um ponto de parada","properties":{"cp":{"type":"integer","description":"Código identificador da parada","example":4200953},"np":{"type":"string","description":"Nome da parada","example":"PARADA ROBERTO SELMI DEI B/C"},"py":{"type":"number","format":"double","description":"Informação de latitude da localização do veículo","example":-23.675901},"px":{"type":"number","format":"double","description":"Informação de longitude da localização do veículo","example":-46.752812},"l":{"type":"object","description":"Relação de linhas localizadas","properties":{"c":{"type":"string","description":"Letreiro completo","example":"7021-10"},"cl":{"type":"integer","description":"Código identificador da linha","example":1989},"sl":{"type":"integer","description":"Sentido de operação onde 1 significa de Terminal Principal para Terminal Secundário e 2 de Terminal Secundário para Terminal Principal","example":1},"lt0":{"type":"string","description":"Letreiro de destino da linha","example":"TERM. JOÃO DIAS"},"lt1":{"type":"string","description":"Letreiro de origem da linha","example":"JD. MARACÁ"},"qv":{"type":"integer","description":"Quantidade de veículos localizados","example":1},"vs":{"type":"object","description":"Relação de veículos localizados","properties":{"p":{"type":"integer","description":"Prefixo do veículo","example":"74558"},"t":{"type":"string","description":"Horário previsto para chegada do veículo no ponto de parada relacionado","example":"23:11"},"a":{"type":"boolean","description":"Indica se o veículo é (true) ou não (false) acessível para pessoas com deficiência","example":true},"ta":{"type":"string","description":"Indica o horário universal (UTC) em que a localização foi capturada. Essa informação está no padrão ISO 8601","example":"2017-05-07T23:09:05Z"},"py":{"type":"number","format":"double","description":"Informação de latitude da localização do veículo","example":-23.67603},"px":{"type":"number","format":"double","description":"Informação de longitude da localização do veículo","example":-46.75891166666667}}}}}}}}},"PrevisaoChegadaLinha":{"type":"object","properties":{"hr":{"type":"string","description":"Horário de referência da geração das informações","example":"20:18"},"ps":{"type":"object","description":"Representa uma relação de pontos de parada.","properties":{"cp":{"type":"integer","description":"Código identificador da parada","example":700016623},"np":{"type":"string","description":"Nome da parada","example":"ANA CINTRA B/C"},"py":{"type":"number","format":"double","description":"Informação de latitude da localização do veículo","example":-23.538763},"px":{"type":"number","format":"double","description":"Informação de longitude da localização do veículo"},"vs":{"type":"object","description":"Relação de veículos localizados","properties":{"p":{"type":"integer","description":"Prefixo do veículo","example":11436},"t":{"type":"string","description":"Horário previsto para chegada do veículo no ponto de parada relacionado","example":"23:26"},"a":{"type":"boolean","description":"Indica se o veículo é (true) ou não (false) acessível para pessoas com deficiência","example":false},"ta":{"type":"string","description":"Indica o horário universal (UTC) em que a localização foi capturada. Essa informação está no padrão ISO 8601","example":"2017-05-07T23:18:02Z"},"py":{"type":"number","format":"double","description":"Informação de latitude da localização do veículo","example":-23.528119999999998},"px":{"type":"number","format":"double","description":"Informação de longitude da localização do veículo","example":-46.670674999999996}}}}}}},"vs":{"type":"object","description":"Relação de veículos localizados","properties":{"p":{"type":"integer","description":"Prefixo do veículo","example":68021},"a":{"type":"boolean","description":"Indica se o veículo é (true) ou não (false) acessível para pessoas com deficiência","example":true},"ta":{"type":"string","description":"Indica o horário universal (UTC) em que a localização foi capturada. Essa informação está no padrão ISO 8601","example":"2017-05-12T14:30:37Z"},"py":{"type":"number","format":"double","description":"Informação de latitude da localização do veículo","example":-23.678712500000003},"px":{"type":"number","format":"double","description":"Informação de longitude da localização do veículo","example":-46.65674}}},"l":{"type":"object","description":"Relação de linhas localizadas.","properties":{"c":{"type":"string","description":"Letreiro completo","example":"5015-10"},"cl":{"type":"integer","description":"Código identificador da linha","example":33887},"sl":{"type":"integer","description":"Sentido de operação onde 1 significa de Terminal Principal para Terminal Secundário e 2 de Terminal Secundário para Terminal Principal","example":2},"lt0":{"type":"string","description":"Letreiro de destino da linha","example":"METRÔ JABAQUARA"},"lt1":{"type":"string","description":"Letreiro de origem da linha","example":"JD. SÃO JORGE"},"qv":{"type":"integer","description":"Quantidade de veículos localizados","example":1},"content":{"$ref":"#/components/schemas/vs"}}}},"securitySchemes":{"default":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://gateway.apilib.prefeitura.sp.gov.br/authorize","scopes":{}}}}}},"servers":[{"url":"https://gateway.apilib.prefeitura.sp.gov.br/sptrans/olhovivo/v2.1"},{"url":"http://gateway.apilib.prefeitura.sp.gov.br/sptrans/olhovivo/v2.1"}]}