PHPackages                             luizcesar/olho-vivo-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. luizcesar/olho-vivo-api

ActiveLibrary[API Development](/categories/api)

luizcesar/olho-vivo-api
=======================

OlhoVivoAPI is a PHP implementation for SPTrans' OlhoVivo.

2.2(9y ago)143MITPHPPHP >=5.5

Since May 7Pushed 9y ago1 watchersCompare

[ Source](https://github.com/luizcesard/OlhoVivoAPI)[ Packagist](https://packagist.org/packages/luizcesar/olho-vivo-api)[ RSS](/packages/luizcesar-olho-vivo-api/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

OlhoVivoAPI
===========

[](#olhovivoapi)

[![License](https://camo.githubusercontent.com/855513c989ea504a9fe4e868e184f125bcd5535eee19a90e556ad0e53fb4e197/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f4c6f6e676d616e2f74656c656772616d2d626f742e737667)](https://github.com/php-telegram-bot/core/LICENSE.md)

PHP implementation of SPTrans' OlhoVivo API v2.1.

Table of Contents
-----------------

[](#table-of-contents)

- [Introduction](#introduction)
- [Instructions](#instructions)-[Get you token](#get-your-token)-[Require this package with Composer](#require-this-package-with-composer)-[Configs](#configs)
- [Usage Example](#usage-example)
- [Troubleshooting](#troubleshooting)
- [License](#license)

Introduction
------------

[](#introduction)

This is a pure PHP Object Oriented implementation of [SPTrans'](http://www.sptrans.com.br/) OlhoVivoAPI v2.1. OlhoVivo official API provides real-time data of São Paulo's (BR) public transportation bus system. All methods [documented](http://www.sptrans.com.br/desenvolvedores/APIOlhoVivo/Documentacao.aspx?1) in the official API have been implemented.

This API can:

- Search for Bus Lines (optionally by way).
- Search for Bus Stops.
- Search for Bus Stops served by a given Bus Line.
- List actual São Paulo's Busways (BRT).
- Report all Companies that provide transportation services at a time.
- Report all vehicles servicing the city by Bus Line and their position at a time.
- Report all vehicles available on a given Bus Line and they position at a time.
- Report all vehicles transmiting position from operator's garage (optionally) by Bus Line.
- Forecast buses arrivals on a given Bus Stop for a given Bus Line at a time.
- Forecast buses arrivals at all Bus Stops served by a given Bus Line.
- Forecast buses arrivals at a given Bus Stop for all Bus Lines that serve it at a time.
- Get KMZ files with actual traffic conditions.

Objects of this package may be used locally together with [GTFS tables](http://www.sptrans.com.br/desenvolvedores/GTFS.aspx).

---

This code is available on [Github](https://github.com/luizcesard/OlhoVivoAPI). Pull requests are welcome.

Instructions
------------

[](#instructions)

### Get your token

[](#get-your-token)

1. Sign up into [SPTrans Devs Area](http://www.sptrans.com.br/desenvolvedores/Cadastro.aspx).
2. After [loging in](http://www.sptrans.com.br/desenvolvedores/Default.aspx), you'll have to create an application name and ask for a token.

### Require this package with Composer

[](#require-this-package-with-composer)

Install this package through [Composer](https://getcomposer.org/). Edit your project's `composer.json` file to require `luizcesar/olho-vivo-api`.

Create *composer.json* file

```
{
    "name": "yourproject/yourproject",
    "type": "project",
    "require": {
        "php": ">=5.6",
        "luizcesar/olho-vivo-api": "*"
    }
}
```

and run `composer update`

**or**

run this command in your command line:

```
composer require luizcesar/olho-vivo-api
```

### Configs

[](#configs)

Open the olhoVivo.php and fill it with your api-key.

Usage Example
-------------

[](#usage-example)

```
use LuizCesar\OlhoVivoAPI\Bulletins\ArrivalForecast;
use LuizCesar\OlhoVivoAPI\Entities\BusLine;
use LuizCesar\OlhoVivoAPI\Entities\BusStop;
use LuizCesar\OlhoVivoAPI\OlhoVivo;

//get an instance of OlhoVivo object
$spTrans = OlhoVivo::getInstance();

$aBusLine = ($spTrans->seekLines("875A",BusLine::WAY_FIRST_LEG))[0]; //The first match of a line search
$busStops = $spTrans->seekBusStopsByLine($aBusLine); //all stops served by $aBusLine
$aBusStop = $busStops[rand(0,count($busStops)-1)]; //get a random bus stop of $busStops'

//Get a Map of all Lines that have buses forecasted to arrive on the chosen bus stop.
$arrivalForecast = $spTrans->getArrivalForecastByStop($aBusStop);
$arrivalsMap = $arrivalForecast->getArrivalsMap(); //Map of Lines and array of buses

echo "Arrival forecast for bus stop at {$aBusStop->getName()}" . PHP_EOL .
	"Issued at: {$arrivalForecast->getTime()}" . PHP_EOL;

//The way to iterate over SplObjectStorage objects.
foreach($arrivalsMap as $line)
{
	echo "{$line->getFullSignCode()} {$line->getActualSignName()}" . PHP_EOL .
	"\t_______________________________" . PHP_EOL .
	"\t| Time  | Bus Id | Accessible |" . PHP_EOL .
	"\t|-------|--------|------------|" . PHP_EOL;
	foreach($arrivalsMap[$line] as $busForecast)
		echo "\t| {$busForecast->getTime()} | {$busForecast->getBus()->getId()}  |    " .
		($busForecast->getBus()->isAcc() == true ? ' YES' : ' NO ') . "    |" . PHP_EOL;
	echo "\t===============================" . PHP_EOL . PHP_EOL;
}
```

And an example output:

```
Arrival forecast for bus stop at R DR.  ALBUQUERQUE LINS
Issued at: 13:41
8000-10 TERM. LAPA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	===============================

8622-10 MORRO DOCE
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	===============================

8400-10 TERM. PIRITUBA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	===============================

8615-10 PQ. DA LAPA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	===============================

8594-10 CID. D'ABRIL
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	| 13:48 | 11448  |     YES    |
	===============================

874T-10 LAPA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	| 13:48 | 11448  |     YES    |
	| 14:08 | 52214  |     YES    |
	===============================

875A-10 PERDIZES
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	| 13:48 | 11448  |     YES    |
	| 14:08 | 52214  |     YES    |
	| 14:22 | 62106  |     NO     |
	| 14:46 | 62096  |     NO     |
	===============================

```

Change Log
----------

[](#change-log)

### v2.2

[](#v22)

- Implementation of `getOwners()` on `Bus` Objects.
- Issues fixes.
- OlhoVivo object is now retrieved by the `getInstance()` method.

### v2.1.0.1

[](#v2101)

- Bug solving.

### v2.1.0

[](#v210)

- Implemented the new version (v2.1) of SPTrans' API.
- All methods are implemented.
- Company objects.
- Better error handling.
- Objects redesigned.

### v0.2

[](#v02)

- Bug Fixes.
- Ability to retrieve bus color.

### v0.1

[](#v01)

- Launched first version.

Troubleshooting
---------------

[](#troubleshooting)

Please, if you find any bugs, report them on [issues](https://github.com/luizcesard/OlhoVivoAPI/issues) page.

License
-------

[](#license)

Please see the [LICENSE](LICENSE.md) included in this repository for a full copy of the MIT license, which this project is licensed under.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~5 days

Total

5

Last Release

3317d ago

Major Versions

0.2 → 2.1.02017-05-18

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/23661158?v=4)[luizcesard](/maintainers/luizcesard)[@luizcesard](https://github.com/luizcesard)

---

Top Contributors

[![luizcesard](https://avatars.githubusercontent.com/u/23661158?v=4)](https://github.com/luizcesard "luizcesard (20 commits)")

---

Tags

apiSao PauloPublic Transportolhovivosptrans

### Embed Badge

![Health badge](/badges/luizcesar-olho-vivo-api/health.svg)

```
[![Health](https://phpackages.com/badges/luizcesar-olho-vivo-api/health.svg)](https://phpackages.com/packages/luizcesar-olho-vivo-api)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.2M46](/packages/tencentcloud-tencentcloud-sdk-php)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.7k371.6k6](/packages/theodo-group-llphant)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[files.com/files-php-sdk

Files.com PHP SDK

2478.1k](/packages/filescom-files-php-sdk)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

563.5M11](/packages/checkout-checkout-sdk-php)[clicksend/clicksend-php

301.6M11](/packages/clicksend-clicksend-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)