# @infiniteloop.ie/avatarapi

> Obtain a name and a profile pic from an email address. Visit AvatarAPI.com for information

Latest version **1.0.1** (published 2022-12-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install @infiniteloop.ie/avatarapi
pnpm add @infiniteloop.ie/avatarapi
yarn add @infiniteloop.ie/avatarapi
bun add @infiniteloop.ie/avatarapi
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-12-16 |
| First published | 2022-12-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Infinite Loop Development Ltd |
| Maintainers | infiniteloop.ie |
| Keywords | email, profile, avatar, avatarapi, api, kyc, social, linkedin, skype, yahoo |

## Links

- npm: https://www.npmjs.com/package/@infiniteloop.ie/avatarapi
- Repository: https://github.com/infiniteloopltd/NPM-AvatarAPI
- Homepage: https://github.com/infiniteloopltd/NPM-AvatarAPI#readme
- Issues: https://github.com/infiniteloopltd/NPM-AvatarAPI/issues
- npm.io page: https://npm.io/package/@infiniteloop.ie/avatarapi

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.2.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-12-16
- 1.0.0 — 2022-12-16

## README

# NPM-AvatarAPI
This is an NPM package for the AvatarAPI.com API - an API that can return a name and profile picture from an email address

It has three functions, getProviders, getCredit, and search

## getProviders
This returns an array of providers available to be searched
```
const avatarapi = require('avatarapi');
avatarapi.getProviders().then(providers => 
{
 for(const providerIndex in providers)
 {
	 var provider = providers[providerIndex];
	 console.log(provider.Name);
 }
}
);
```

## getCredit
This returns the amount of credit in your AvatarAPI.com account
```
const avatarapi = require('avatarapi');
avatarapi.getCredit("YOUR_USERNAME","YOUR_PASSWORD").then(credit => 
{
 console.log(credit.credits);
});
```

## search
This returns the name and profile picture url from an email address
```
const avatarapi = require('avatarapi');
avatarapi.search("YOUR_USERNAME","YOUR_PASSWORD","Coco_crocodile@outlook.com").then(result => 
{
 console.log(result);
});
```

---
_Source: https://npm.io/package/@infiniteloop.ie/avatarapi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._