https://github.com/socrata/soda-php
A simple library to make it easier to access SODA services from PHP
https://github.com/socrata/soda-php
engineering
Last synced: 3 months ago
JSON representation
A simple library to make it easier to access SODA services from PHP
- Host: GitHub
- URL: https://github.com/socrata/soda-php
- Owner: socrata
- License: other
- Created: 2010-04-26T22:05:58.000Z (about 16 years ago)
- Default Branch: main
- Last Pushed: 2022-01-03T20:47:07.000Z (over 4 years ago)
- Last Synced: 2025-12-04T10:28:00.097Z (6 months ago)
- Topics: engineering
- Language: PHP
- Homepage: http://dev.socrata.com
- Size: 40 KB
- Stars: 63
- Watchers: 61
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/socrata/soda-php)
# Socrata - Basic PHP Library
This library provides a simple wrapper for accessing some of the features of the Socrata Open Data API from PHP. Currently it supports HTTP GET, POST, and PUT operations.
The library is very simple. To access the Socrata API, you first instantiate a "Socrata" object, passing in the domain of the data site you wish to access. The library will also accept the full root path including the protocol (ex: `http://data.medicare.gov`). Then you can use its included methods to make simple API calls:
## Supported PHP versions
In order to access the SODA API via HTTPS, clients must now [support the Server Name Indication (SNI)](https://dev.socrata.com/changelog/2016/08/24/sni-now-required-for-https-connections.html) extension to the TLS protocol. What does this mean? It means that if you're using `soda-php`, you must [use PHP 5.6 or above](https://en.wikipedia.org/wiki/Server_Name_Indication), as that is when PHP introduced support for SNI.
## Install
Via composer
``` bash
composer require socrata/soda-php
```
## Usage
```php
$socrata = new Socrata("data.medicare.gov");
$response = $socrata->get("abcd-2345");
```
In your API calls, specify ether the full endpoint relative path (eg: `/resource/abcd-2345.json`), or the dataset ID (eg: `abcd-2345`).
## Querying
[Simple filters](http://dev.socrata.com/docs/filtering.html) and [SoQL Queries](http://dev.socrata.com/docs/queries.html) can be passed as a parameter to the `get` function:
```php
$socrata = new Socrata("data.austintexas.gov", $app_token);
$params = array("\$where" => "within_circle(location, $latitude, $longitude, $range)");
$response = $socrata->get($view_uid, $params);
```
## Publishing
To use the library to publish data you can use the PUT (replace) or POST (upsert) methods:
```php
$socrata = new Socrata("data.medicare.gov", $app_token, $user_name, $password);
// Publish data via 'upsert'
$response = $socrata->post("abcd-2345", $data_as_json);
// Publish data via 'replace'
$response = $socrata->put("abcd-2345", $data_as_json);
```
The library also includes a simple example application, which retrieves rows from a dataset and dumps them in a simple table.
## License
Apache License, Version 2.0. Please see [License File](LICENSE) for more information.