ninjapear 1.1.0
NinjaPear API
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, NinjaPear API

# 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:
1. Look up the customers, investors, and partners/platforms of any business globally.
2. (FREE) Retrieve the logo of any company.
3. (FREE) Find out the nature of an email address.
4. (FREE) Check your credit balance.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:

```sh
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:
```python
import ninjapear
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ninjapear
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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 of the target company
    include_employee_count = False # bool | Fetch fresh employee count data via web search. Adds 2 credits. (optional) (default to False)

    try:
        # Company Details
        api_response = api_instance.get_company_details(website, include_employee_count=include_employee_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**](docs/CompanyAPIApi.md#get_company_details) | **GET** /api/v1/company/details | Company Details
*CompanyAPIApi* | [**get_company_logo**](docs/CompanyAPIApi.md#get_company_logo) | **GET** /api/v1/company/logo | Company Logo
*CompanyAPIApi* | [**get_employee_count**](docs/CompanyAPIApi.md#get_employee_count) | **GET** /api/v1/company/employee-count | Employee Count
*ContactAPIApi* | [**check_disposable_email**](docs/ContactAPIApi.md#check_disposable_email) | **GET** /api/v1/contact/disposable-email | Disposable Email Checker
*CustomerAPIApi* | [**get_customer_listing**](docs/CustomerAPIApi.md#get_customer_listing) | **GET** /api/v1/customer/listing | Customer Listing
*MetaAPIApi* | [**get_credit_balance**](docs/MetaAPIApi.md#get_credit_balance) | **GET** /api/v1/meta/credit-balance | View Credit Balance


## Documentation For Models

 - [Address](docs/Address.md)
 - [CompanyDetailsResponse](docs/CompanyDetailsResponse.md)
 - [CreditBalanceResponse](docs/CreditBalanceResponse.md)
 - [CustomerCompany](docs/CustomerCompany.md)
 - [CustomerListingResponse](docs/CustomerListingResponse.md)
 - [DisposableEmailResponse](docs/DisposableEmailResponse.md)
 - [EmployeeCountResponse](docs/EmployeeCountResponse.md)
 - [Error](docs/Error.md)
 - [Executive](docs/Executive.md)
 - [PublicListing](docs/PublicListing.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication


## Author

hello@nubela.co