# Nymeria
[](https://badge.fury.io/py/nymeria)
The official python package to interact with Nymeria's service.
You can use Nymeria to enrich data with contact information such as email
addresses, phone numbers and social links. The python package wraps Nymeria's [public
API](https://www.nymeria.io/developers) so you don't have to.
## Usage
#### Installation
```bash
pip install nymeria
```
#### Setting up a Client
```python
from nymeria import api
client = api.Client('YOUR API KEY GOES HERE')
```
All actions that interact with the Nymeria service assume an API key has been
set and will fail if a key hasn't been set. A key only needs to be set once and
can be set at the start of your program.
#### Verifying an Email Address
```python
from nymeria import api
client = api.Client('YOUR API KEY GOES HERE')
client.email.verify('dev@nymeria.io')
```
You can verify the deliverability of an email address using Nymeria's service.
The response will contain a result and tags.
The result will either be "valid" or "invalid". The tags will give you
additional details regarding the email address. For example, the tags will tell
you if the mail server connection was successful, if the domain's DNS records
are set up to send and receive email, etc.
#### Enriching a Profile
```python
from nymeria import api
client = api.Client('YOUR API KEY GOES HERE')
# Single Enrichment
client.person.enrich({ 'profile': 'linkedin.com/in/wozniaksteve' }) # => dict (see below)
# Bulk Enrichment (pass n-queries to enrich)
people = client.person.bulk_enrich([
{ 'params': { 'email': 'someone@somewhere.com' } },
{ 'params': { 'profile': 'github.com/dhh' } },
{ 'params': { 'profile': 'linkedin.com/in/wozniaksteve' } },
])
```
You can enrich one or more profiles using the enrich function. The enrich
function takes a dict, or an array of dicts. The most common dict keys
to use are `profile` and `email`.
If you want to enrich an email address you can specify an email and the Nymeria
service will locate the person and return all associated data for them.
Likewise, you can specify a supported url via the url parameter if you prefer
to enrich via a url.
At this time, Nymeria supports look ups for the following sites:
1. LinkedIn
1. Facebook
1. Twitter
1. GitHub
Please note, if using LinkedIn urls provide the public profile LinkedIn url.
Two other common parameters are filter and require. If you wish to filter out
professional emails (only receive personal emails) you can do so by specifying
"professional-emails" as the filter parameter.
The require parameter works by requiring certain kinds of data. For example,
you can request an enrichment but only receive a result if the profile
contains a phone number (or an email, personal email, professional email,
etc). The following are all valid requirements:
1. "email"
1. "phone"
1. "professional-email"
1. "personal-email"
You can specify multiple requirements by using a comma
between each requirement. For example you can require a
phone and personal email with: "phone,personal-email" as
the require parameter.
#### Searching for People
```python
from nymeria import api
client = api.Client('YOUR API KEY GOES HERE')
people = client.person.search({
'company': 'nymeria',
'title': 'founder',
'limit': 1
})
```
The dict parameter enables you to specify your search criteria. In
particular, you can specify:
1. `first_name`
1. `last_name`
1. `title`
1. `company`
1. `location`
1. `country`
1. `industry`
1. `limit` for the number of results to return.
1. `offset` the offset from the base results..
By default, 10 people will be returned for each page of search
results. You can specify the page as part of your dict if you
want to access additional pages of people.
## License
MIT License
Copyright (c) 2025, Nymeria LLC.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": "https://github.com/nymeria-io/nymeria.py",
"name": "nymeria",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "osint contact-discovery email-finder phonenumber-finder",
"author": "Nymeria, LLC",
"author_email": "dev@nymeria.io",
"download_url": "https://files.pythonhosted.org/packages/09/43/ce713b4edb9d07734c62c55c3b8a912f0b961fc21a20fbd0716ac14f7fa7/nymeria-1.2.0.tar.gz",
"platform": null,
"description": "# Nymeria\n\n[](https://badge.fury.io/py/nymeria)\n\nThe official python package to interact with Nymeria's service.\n\nYou can use Nymeria to enrich data with contact information such as email\naddresses, phone numbers and social links. The python package wraps Nymeria's [public\nAPI](https://www.nymeria.io/developers) so you don't have to.\n\n\n\n## Usage\n\n#### Installation\n\n```bash\npip install nymeria\n```\n\n#### Setting up a Client\n\n```python\nfrom nymeria import api\n\nclient = api.Client('YOUR API KEY GOES HERE')\n```\n\nAll actions that interact with the Nymeria service assume an API key has been\nset and will fail if a key hasn't been set. A key only needs to be set once and\ncan be set at the start of your program.\n\n#### Verifying an Email Address\n\n```python\nfrom nymeria import api\n\nclient = api.Client('YOUR API KEY GOES HERE')\n\nclient.email.verify('dev@nymeria.io')\n```\n\nYou can verify the deliverability of an email address using Nymeria's service.\nThe response will contain a result and tags.\n\nThe result will either be \"valid\" or \"invalid\". The tags will give you\nadditional details regarding the email address. For example, the tags will tell\nyou if the mail server connection was successful, if the domain's DNS records\nare set up to send and receive email, etc.\n\n#### Enriching a Profile\n\n```python\nfrom nymeria import api\n\nclient = api.Client('YOUR API KEY GOES HERE')\n\n# Single Enrichment\n\nclient.person.enrich({ 'profile': 'linkedin.com/in/wozniaksteve' }) # => dict (see below)\n\n# Bulk Enrichment (pass n-queries to enrich)\n\npeople = client.person.bulk_enrich([\n { 'params': { 'email': 'someone@somewhere.com' } }, \n { 'params': { 'profile': 'github.com/dhh' } },\n { 'params': { 'profile': 'linkedin.com/in/wozniaksteve' } },\n])\n```\n\nYou can enrich one or more profiles using the enrich function. The enrich\nfunction takes a dict, or an array of dicts. The most common dict keys\nto use are `profile` and `email`.\n\nIf you want to enrich an email address you can specify an email and the Nymeria\nservice will locate the person and return all associated data for them.\nLikewise, you can specify a supported url via the url parameter if you prefer\nto enrich via a url.\n\nAt this time, Nymeria supports look ups for the following sites:\n\n1. LinkedIn\n1. Facebook\n1. Twitter\n1. GitHub\n\nPlease note, if using LinkedIn urls provide the public profile LinkedIn url.\n\nTwo other common parameters are filter and require. If you wish to filter out\nprofessional emails (only receive personal emails) you can do so by specifying\n\"professional-emails\" as the filter parameter.\n\nThe require parameter works by requiring certain kinds of data. For example,\nyou can request an enrichment but only receive a result if the profile\ncontains a phone number (or an email, personal email, professional email,\netc). The following are all valid requirements:\n\n1. \"email\"\n1. \"phone\"\n1. \"professional-email\"\n1. \"personal-email\"\n\nYou can specify multiple requirements by using a comma\nbetween each requirement. For example you can require a\nphone and personal email with: \"phone,personal-email\" as\nthe require parameter.\n\n#### Searching for People\n\n```python\nfrom nymeria import api\n\nclient = api.Client('YOUR API KEY GOES HERE')\n\npeople = client.person.search({ \n 'company': 'nymeria',\n 'title': 'founder', \n 'limit': 1\n})\n```\n\nThe dict parameter enables you to specify your search criteria. In\nparticular, you can specify:\n\n1. `first_name` \n1. `last_name` \n1. `title` \n1. `company` \n1. `location` \n1. `country` \n1. `industry` \n1. `limit` for the number of results to return.\n1. `offset` the offset from the base results..\n\nBy default, 10 people will be returned for each page of search\nresults. You can specify the page as part of your dict if you\nwant to access additional pages of people.\n\n## License\n\nMIT License\n\nCopyright (c) 2025, Nymeria LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Discover contact details such as phone numbers, email addresses and social links using Nymeria's service.",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/nymeria-io/nymeria.py"
},
"split_keywords": [
"osint",
"contact-discovery",
"email-finder",
"phonenumber-finder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0943ce713b4edb9d07734c62c55c3b8a912f0b961fc21a20fbd0716ac14f7fa7",
"md5": "51c33a5ea484b73c7765b1fa8b0e536f",
"sha256": "10f5969497b691d676769664172fdd4bdeeea0d06034cb7a7a76192e705f6559"
},
"downloads": -1,
"filename": "nymeria-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "51c33a5ea484b73c7765b1fa8b0e536f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4420,
"upload_time": "2025-02-03T19:04:34",
"upload_time_iso_8601": "2025-02-03T19:04:34.630717Z",
"url": "https://files.pythonhosted.org/packages/09/43/ce713b4edb9d07734c62c55c3b8a912f0b961fc21a20fbd0716ac14f7fa7/nymeria-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-03 19:04:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nymeria-io",
"github_project": "nymeria.py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nymeria"
}
JSON
