PHPackages                             optimaize/nameapi-client-php - 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. optimaize/nameapi-client-php

ActiveLibrary[API Development](/categories/api)

optimaize/nameapi-client-php
============================

PHP Client for the NameAPI Web Service

5.0.0(8y ago)27118.5k↑3445.8%4[13 issues](https://github.com/optimaize/nameapi-client-php/issues)[3 PRs](https://github.com/optimaize/nameapi-client-php/pulls)LGPL-3.0PHPPHP >=5.3.0

Since May 3Pushed 3y ago4 watchersCompare

[ Source](https://github.com/optimaize/nameapi-client-php)[ Packagist](https://packagist.org/packages/optimaize/nameapi-client-php)[ Docs](https://github.com/optimaize/nameapi-client-php)[ RSS](/packages/optimaize-nameapi-client-php/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (9)DependenciesVersions (8)Used By (0)

nameapi-client-php
==================

[](#nameapi-client-php)

PHP Client for the NameAPI Web Service at

All you need to send requests is your own api key, get it from nameapi.org.

Library setup
-------------

[](#library-setup)

The recommended way is to use Composer. The project at shows how that's done.

You can download the source code and make it available to your code. Or you can check it out directly from this GitHub project. Currently there is no phar available.

The only requirement is that the php\_curl extension is enabled.

Functional tests
----------------

[](#functional-tests)

Functional tests that demonstrate how the services work, and that they work, are in  you can look at the code, and you can even run those tests using your api key and PHPUnit.

Setup code
----------

[](#setup-code)

At first you need one single include, the one to the nameapi service factory:

```
require_once('your/path/to/org/nameapi/client/services/ServiceFactory.php');
```

Then you need a Context that explains a bit your working environment, something like:

```
use org\nameapi\ontology\input\context\Context;
use org\nameapi\ontology\input\context\Priority;
$context = Context::builder()
    ->place('US')
    ->priority(Priority::REALTIME())
    ->build();
```

Then you can already create the service factory which gives you access to all nameapi services:

```
$serviceFactory = new ServiceFactory('your-api-key', $context);
```

Send a ping
-----------

[](#send-a-ping)

This code sends a simple ping to nameapi to test the connection:

```
$ping = $serviceFactory->systemServices()->ping();
$pong = $ping->ping();
```

If the response is 'pong' then all is fine and you can move on to the real goodies.

Input / Output
--------------

[](#input--output)

All input objects come with builders or nicely documented setters. The result objects returned by the services all have fully documented getters. Many input arguments are optional - that means you can start simple, and add more as you need.

Behind the scenes this service api uses REST. But luckily you don't need to worry about any of the interface detail, you can just use the provided classes.

#### Person input object

[](#person-input-object)

Most services accept a 'Person' as input. This person contains a name, and optionally more data such as gender, birth date etc. The name can be just a single "full name" string, or it can be composed of multiple fields like given name, middle name, surname. This standardized api makes it simple to use different services in a consistent way, and is very convenient in accepting the data however you have it at hands.

Creating a simple person looks something like this:

```
use org\nameapi\ontology\input\entities\person\NaturalInputPerson;
use org\nameapi\ontology\input\entities\person\name\InputPersonName;
$inputPerson = NaturalInputPerson::builder()
    ->name(InputPersonName::westernBuilder()
        ->fullname( "John F. Kennedy" )
        ->build())
    ->build();
```

Name Parser
-----------

[](#name-parser)

Name parsing is the process of splitting a full name into its components.

Using the $inputPerson created earlier:

```
$personNameParser = $this->makeServiceFactory()->parserServices()->personNameParser();
$parseResult = $personNameParser->parse($inputPerson);
var_dump($parseResult);
```

Name Genderizer
---------------

[](#name-genderizer)

Name genderizing is the process of identifying the gender based on a person's name.

Using the $inputPerson created earlier:

```
$personGenderizer = $serviceFactory->genderizerServices()->personGenderizer();
$personGenderResult = $personGenderizer->assess($inputPerson);
echo $personGenderResult->getGender()->toString(); //will print 'MALE'
```

Name Matcher
------------

[](#name-matcher)

The Name Matcher compares names and name pairs to discover whether the people could possibly be one and the same person.

This service takes 2 people as input:

```
$personMatcher = $serviceFactory->matcherServices()->personMatcher();
$inputPerson1 = NaturalInputPerson::builder()
    ->name(InputPersonName::westernBuilder()
        ->fullname( "John F. Kennedy" )
        ->build())
    ->build();
$inputPerson2 = NaturalInputPerson::builder()
    ->name(InputPersonName::westernBuilder()
        ->fullname( "Jack Kennedy" )
        ->build())
    ->build();
$personMatcherResult = $personMatcher->match($inputPerson1, $inputPerson2);
echo $personMatcherResult->getPersonMatchType()->toString(); //will print 'MATCHING'
```

Name Formatter
--------------

[](#name-formatter)

The Name Formatter displays personal names in the desired form. This includes the order as well as upper and lower case writing.

```
$personNameFormatter = $serviceFactory->formatterServices()->personNameFormatter();
$inputPerson = NaturalInputPerson::builder()
    ->name(InputPersonName::westernBuilder()
        ->fullname( "john kennedy" )
        ->build())
    ->build();
$formatterResult = $personNameFormatter->format($inputPerson, new FormatterProperties());
echo $formatterResult->getFormatted(); //will print 'John Kennedy'
```

Email Name Parser
-----------------

[](#email-name-parser)

The Email Name Parser extracts names out of email addresses.

```
$emailNameParser = $serviceFactory->emailServices()->emailNameParser();
$result = $emailNameParser->parse("john.doe@example.com");
echo $result;
```

Disposable Email Address Detector
---------------------------------

[](#disposable-email-address-detector)

The DEA-Detector checks email addresses against a list of known "trash domains" such as mailinator.com.

```
$deaDetector = $serviceFactory->emailServices()->disposableEmailAddressDetector();
$result = $deaDetector->isDisposable("abcdefgh@10minutemail.com");
echo $result->getDisposable()->toString()); //will print 'YES'
```

Risk Detector
-------------

[](#risk-detector)

The Risk-Detector checks all data in the person input, including the name, address, birthdate, email address and phone number for fake and suspicious data.

```
$riskDetector = $serviceFactory->riskServices()->personRiskDetector();
$riskResult = $riskDetector->detect($inputPerson);
var_dump($riskResult);
```

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance10

Infrequent updates — may be unmaintained

Popularity43

Moderate usage in the ecosystem

Community13

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 96.8% 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 ~93 days

Recently: every ~20 days

Total

7

Last Release

3143d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/013c909df1a0685ad615f5d016b5d350af76ea67ae21e32d8519ed7dcc203352?d=identicon)[fabian.kessler](/maintainers/fabian.kessler)

---

Top Contributors

[![fabiankessler](https://avatars.githubusercontent.com/u/2506130?v=4)](https://github.com/fabiankessler "fabiankessler (91 commits)")[![stefancretu](https://avatars.githubusercontent.com/u/2303103?v=4)](https://github.com/stefancretu "stefancretu (3 commits)")

### Embed Badge

![Health badge](/badges/optimaize-nameapi-client-php/health.svg)

```
[![Health](https://phpackages.com/badges/optimaize-nameapi-client-php/health.svg)](https://phpackages.com/packages/optimaize-nameapi-client-php)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)

PHPackages © 2026

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