ninjapear-py
NinjaPear is a data platform that seeks to serve as the single source of truth for B2B data, be it to power your data-driven applications or your sales-driven workflow.
As a data client of NinjaPear API, you can:
- Look up the customers, investors, and partners/platforms of any business globally.
- (FREE) Retrieve the logo of any company.
- (FREE) Find out the nature of an email address.
- (FREE) Check your credit balance.
- Monitor companies for updates (blog posts, X/Twitter posts, website changes) via RSS feeds.
- Look up detailed company information (description, industry, executives, financials).
- Get company funding history and investors.
- Enrich person/employee professional profiles.
- Discover competitors of any company (by keyword overlap and product overlap).
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.19.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import ninjapear
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import ninjapear
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import ninjapear
from ninjapear.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://nubela.co
# See configuration.py for a list of all supported configuration parameters.
configuration = ninjapear.Configuration(
host = "https://nubela.co"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = ninjapear.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with ninjapear.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ninjapear.CompanyAPIApi(api_client)
website = 'https://www.stripe.com' # str | The website URL or company name of the target company. A website URL (e.g. `https://www.stripe.com`) is strongly recommended for precision.
include_employee_count = False # bool | Fetch fresh employee count data via web search. Adds 2 credits. (optional) (default to False)
follower_count = 'follower_count_example' # str | Set to 'include' to fetch Twitter/X follower and following counts. Adds 1 credit. (optional)
try:
# Company Details
api_response = api_instance.get_company_details(website, include_employee_count=include_employee_count, follower_count=follower_count)
print("The response of CompanyAPIApi->get_company_details:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CompanyAPIApi->get_company_details: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://nubela.co
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CompanyAPIApi | get_company_details | GET /api/v1/company/details | Company Details |
| CompanyAPIApi | get_company_funding | GET /api/v1/company/funding | Company Funding |
| CompanyAPIApi | get_company_logo | GET /api/v1/company/logo | Company Logo |
| CompanyAPIApi | get_company_updates | GET /api/v1/company/updates | Company Updates |
| CompanyAPIApi | get_company_website | GET /api/v1/company/website | Website Lookup |
| CompanyAPIApi | get_employee_count | GET /api/v1/company/employee-count | Employee Count |
| CompetitorAPIApi | get_competitor_listing | GET /api/v1/competitor/listing | Competitor Listing |
| ContactAPIApi | check_disposable_email | GET /api/v1/contact/disposable-email | Disposable Email Checker |
| CustomerAPIApi | get_customer_listing | GET /api/v1/customer/listing | Customer Listing |
| EmployeeAPIApi | get_person_profile | GET /api/v1/employee/profile | Person Profile Enrichment |
| EmployeeAPIApi | get_work_email | GET /api/v1/employee/work-email | Work Email Lookup |
| MetaAPIApi | get_credit_balance | GET /api/v1/meta/credit-balance | View Credit Balance |
| MonitorAPIApi | add_target | POST /api/v1/monitor/feeds/{feed_id}/targets | Add Target |
| MonitorAPIApi | create_feed | POST /api/v1/monitor/feeds | Create Feed |
| MonitorAPIApi | delete_feed | DELETE /api/v1/monitor/feeds/{feed_id} | Delete Feed |
| MonitorAPIApi | delete_target | DELETE /api/v1/monitor/feeds/{feed_id}/targets/{target_id} | Delete Target |
| MonitorAPIApi | get_feed | GET /api/v1/monitor/feeds/{feed_id} | Get Feed |
| MonitorAPIApi | get_rss_feed | GET /api/v1/monitor/feeds/{feed_id}/rss.xml | Get RSS Feed |
| MonitorAPIApi | list_feeds | GET /api/v1/monitor/feeds | List Feeds |
| MonitorAPIApi | update_feed | PATCH /api/v1/monitor/feeds/{feed_id} | Update Feed |
| MonitorAPIApi | update_target | PATCH /api/v1/monitor/feeds/{feed_id}/targets/{target_id} | Update Target |
Documentation For Models
- AddTargetRequest
- Address
- CompanyDetailsResponse
- CompanyFundingResponse
- CompanyUpdate
- CompanyUpdatesResponse
- CompanyWebsiteResponse
- CompetitorCompany
- CompetitorListingResponse
- CreateFeedRequest
- CreateFeedRequestTargetsInner
- CreditBalanceResponse
- CustomerCompany
- CustomerListingResponse
- DisposableEmailResponse
- Education
- EmployeeCountResponse
- Error
- Executive
- Feed
- FeedListResponse
- FeedSummary
- FundingRound
- Investor
- MessageResponse
- PersonProfileResponse
- PublicListing
- Target
- TargetSettings
- UpdateFeedRequest
- UpdateTargetRequest
- WorkEmailResponse
- WorkExperience
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
Author
Metadata
Release files for ninjapear 1.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ninjapear-1.6.0.tar.gz | 60.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ninjapear-1.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 179.5 kB
Release files / ninjapear-1.6.0.tar.gz
| Download URL | ninjapear-1.6.0.tar.gz |
|---|---|
| Size | 60.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
382a8f7f9b49f3eee4c5802a56163cbe883da4ee5f0ace2d31f20a0602489bba
|
|
BLAKE2b-256 checksum How to use checksums |
f13f3160b5a8501dad16c662c634852ae547385f75b2fb9624ff0ff4f71a88e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / ninjapear-1.6.0-py3-none-any.whl
| Download URL | ninjapear-1.6.0-py3-none-any.whl |
|---|---|
| Size | 119.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0fe15c4366e41098f7f8e1617c9277ba4dd143244c0cc3846838b0fe5525b173
|
|
BLAKE2b-256 checksum How to use checksums |
8b8801246e6e1b4757ad9b151afa499ac271ee3eaab35e95a069639e7c6c2194
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|