PHPackages                             primitivesocial/nestio-api-wrapper - 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. primitivesocial/nestio-api-wrapper

ActiveLibrary[API Development](/categories/api)

primitivesocial/nestio-api-wrapper
==================================

Nestio API Wrapper

1.3(5y ago)03.6k1MITPHPPHP >=7.1.0CI failing

Since May 1Pushed 5y ago3 watchersCompare

[ Source](https://github.com/PrimitiveSocial/nestio-api-wrapper)[ Packagist](https://packagist.org/packages/primitivesocial/nestio-api-wrapper)[ Docs](https://primitivesocial.com)[ RSS](/packages/primitivesocial-nestio-api-wrapper/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (9)Dependencies (8)Versions (10)Used By (0)

Nestio API Package
==================

[](#nestio-api-package)

Installation
------------

[](#installation)

`composer require primitivesocial/nestio-api-wrapper`

`php artisan vendor:publish` to publish the config

Configuration
-------------

[](#configuration)

Add `NESTIO_API_KEY=` to your .env with your Nestio API key.

Methods
-------

[](#methods)

### Listings

[](#listings)

To use the Listings object, include `use PrimitiveSocial\NestioApiWrapper\Listings;` in your file.

#### Get All Listings

[](#get-all-listings)

Nestio API Link:

```
$client = new Listings($apiKey);

$output = $client->all();

```

##### Params

[](#params)

These are called as chainable functions off of your clients. Example:

```
$client->commercialUse('industrial')
        ->listingType('sales')
        ->hasPhotos()
        ->all();

```

Here is the list:

- agents
- geometry
- listingType
- propertyType
- commercialUse
- building
- buildingNameAddress
- buildingOwnership
- company
- exclusive
- minPrice
- maxPrice
- elevator
- doorman
- pets
- layout
- bathrooms
- neighborhoods
- postalCode
- dateAvailableBefore
- dateAvailableAfter
- hasPhotos
- incentives
- openHouseBegin
- openHouseEnd
- featured
- source
- city
- isRenovated
- dishwasher
- microwave
- exposedBrick
- hardwoodFloors
- virtualDoorman
- storage
- shortTerm
- liveInSuper
- lastListedAtBefore
- lastListedAtAfter
- parking
- includePrivate
- sort
- displayAgent

Boolean parameters can be called without any parameters; the package will assume that, if you are calling it, you want it. You can also specify `false`.

#### byId

[](#byid)

Nestio API Documentation here:

This is for specific listings you would want to see. All of the above parameters can be called as well.

```
$client = new Listings('APIKEY');

$output = $client->all();

$listingFromOutput = $output['items'][0];

$listing = $client->byId($listingFromOutput['id']);

```

#### residentialRentals

[](#residentialrentals)

This function acts as the `all` function, getting all residential rentals.

```
$client = new Listings($apiKey);

$output = $client->residentialRentals();

```

#### residentialSales

[](#residentialsales)

This function acts as the `all` function, getting all residential sales

```
$client = new Listings($apiKey);

$output = $client->residentialSales();

```

#### commercialRentals

[](#commercialrentals)

This function acts as the `all` function, getting all commercial rentals

```
$client = new Listings($apiKey);

$output = $client->commercialRentals();

```

#### commercialSales

[](#commercialsales)

This function acts as the `all` function, getting all commercial sales

```
$client = new Listings($apiKey);

$output = $client->commercialSales();

```

### Agents

[](#agents)

To use the Agents object, include `use PrimitiveSocial\NestioApiWrapper\Agents;` in your file.

#### Get All Agent

[](#get-all-agent)

Nestio API Link:

```
$client = new Agents('APIKEY');

$output = $client->all();

```

There are no parameters assigned to this call.

#### Get Agent By ID

[](#get-agent-by-id)

Nestio API Link:

```
$output = $client->all();

$this->assertNotNull($output);

$agentFromInitial = $output['items'][0];

$agent = $client->byId($agentFromInitial['id']);

```

There are no parameters assigned to this call.

### Buildings

[](#buildings)

To use the Buildings object, include `use PrimitiveSocial\NestioApiWrapper\Buildings;` in your file.

Nestio API Link:

```
$client = new Buildings('APIKEY');

$output = $client->all();

```

There are no parameters for this call.

### Neighborhoods

[](#neighborhoods)

To use the Neighborhoods object, include `use PrimitiveSocial\NestioApiWrapper\Neighborhoods;` in your file.

Nestio API Link:

```
$client = new Neighborhoods('APIKEY');

$output = $client->all();

```

#### Params

[](#params-1)

- city
- state

```
$client = new Neighborhoods('APIKEY');

$output = $client->city('Philadelphia')
                ->state('PA')
                ->all();

```

### Clients

[](#clients)

This call is a POST call to create clients in Nestio.

To use the Clients object, include `use PrimitiveSocial\NestioApiWrapper\Clients;` in your file.

Nestio API Link :

```
$client = new Clients('APIKEY');

        // Create persons
        $client->person([
            'first_name'    => 'Gerbil',
            'last_name'     => 'McPherson',
            'email'         => 'nestio@example.com',
            'phone_1'       => '215-555-5555',
            'is_primary'    => true
        ]);

        $client->person([
            'first_name'    => 'Albert',
            'last_name'     => 'Bundy',
            'email'         => 'al@example.com',
            'phone_1'       => '215-555-5551',
            'is_primary'    => false
        ]);

        $client->moveInDate('2019-06-01')
                ->group('1234')
                ->layout('1br')
                ->clientReferral('Ted McGinley')
                ->discoverySource('zillow')
                ->device('phone')
                ->sourceType('organic');

        $output = $client->submit();

```

To create a client, you must have:

- a person with a first\_name and last\_name
- a group number assigned.

You can add as many `person`s as needed. Each `person` function call creates a new `People` object in the client.

#### Params

[](#params-2)

- person
- moveInDate
- layout
- price\_floor
- price\_ceiling
- notes
- group
- brokerCompany
- brokerEmail
- brokerFirstName
- brokerLastName
- brokerPhone
- clientReferral
- campaignInfo
- unit
- discoverySource
- leadSource
- device
- sourceType

#### Client Status

[](#client-status)

You can also update the client status by using the Nestio Client ID and the status:

```
$client = new Clients('APIKEY');

$output = $client->id($nestioClientId)
                ->status($status)
                ->update();

```

Statuses can be set to:

- lead
- toured
- applicant
- resident
- not-a-prospect

Contributing
------------

[](#contributing)

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

### Pull Request Process

[](#pull-request-process)

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

### Code of Conduct

[](#code-of-conduct)

#### Our Pledge

[](#our-pledge)

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

#### Our Standards

[](#our-standards)

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

#### Our Responsibilities

[](#our-responsibilities)

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

#### Scope

[](#scope)

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

#### Enforcement

[](#enforcement)

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

#### Attribution

[](#attribution)

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/)

License
-------

[](#license)

MIT. See LICENSE for more information.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 75% 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 ~76 days

Recently: every ~96 days

Total

7

Last Release

2113d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9833fa1630bcd67c1340f785eafdea467a48b3c665bcc4e59b1253e0fa400762?d=identicon)[jerredhurst](/maintainers/jerredhurst)

---

Top Contributors

[![dougblackjr](https://avatars.githubusercontent.com/u/6020323?v=4)](https://github.com/dougblackjr "dougblackjr (18 commits)")[![akhandev](https://avatars.githubusercontent.com/u/51113855?v=4)](https://github.com/akhandev "akhandev (4 commits)")[![matthewtrask](https://avatars.githubusercontent.com/u/4731244?v=4)](https://github.com/matthewtrask "matthewtrask (2 commits)")

---

Tags

apinestio

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/primitivesocial-nestio-api-wrapper/health.svg)

```
[![Health](https://phpackages.com/badges/primitivesocial-nestio-api-wrapper/health.svg)](https://phpackages.com/packages/primitivesocial-nestio-api-wrapper)
```

###  Alternatives

[andreaselia/laravel-api-to-postman

Generate a Postman collection automatically from your Laravel API

1.0k586.2k3](/packages/andreaselia-laravel-api-to-postman)[smodav/mpesa

M-Pesa API implementation

16363.7k1](/packages/smodav-mpesa)[vluzrmos/slack-api

Wrapper for Slack.com WEB API.

102589.1k3](/packages/vluzrmos-slack-api)[specialtactics/l5-api

Dependencies for the Laravel API Boilerplate package

3672.8k2](/packages/specialtactics-l5-api)[ardakilic/mutlucell

Mutlucell SMS API wrapper for sending sms text messages for Laravel

457.3k](/packages/ardakilic-mutlucell)[dariusiii/tmdb-laravel

Laravel Package for TMDB ( The Movie Database ) API. Provides easy access to the wtfzdotnet/php-tmdb-api library.

1821.1k](/packages/dariusiii-tmdb-laravel)

PHPackages © 2026

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