Getting Started with apollo-rest-api

Introduction

The Apollo API provides programmatic access to Apollo, the all-in-one sales intelligence and engagement platform. Use it to enrich people and company data (individually or in bulk), search Apollo's database of over 240 million contacts and 30 million companies, and manage accounts, contacts, deals, sequences, tasks, calls, and conversations in your go-to-market workflows.

Base URL

All API requests are made to https://api.apollo.io/api/v1.

Authentication

• Apollo users authenticate with an API key passed in the x-api-key request header. See Create API Keys.
• Apollo partners building integrations on behalf of mutual users authenticate with the OAuth 2.0 authorization flow.

Rate limits & credits

Rate limits and credit consumption depend on your Apollo pricing plan. Check your current limits and usage with the View API Usage Stats and Rate Limits endpoint. For more details, see Rate Limits and the API FAQs.

New to the API? Start with the Apollo API overview.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-apollo-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/apimatic-apollo-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from apollorestapi.apollorestapi_client import ApollorestapiClient
from apollorestapi.configuration import Environment
from apollorestapi.http.auth.api_key import ApiKeyCredentials
from apollorestapi.http.auth.bearer_auth import BearerAuthCredentials
from apollorestapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from apollorestapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from apollorestapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = ApollorestapiClient(
    api_key_credentials=ApiKeyCredentials(
        x_api_key='x-api-key'
    ),
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from apollorestapi.apollorestapi_client import ApollorestapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ApollorestapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

• apiKey (Custom Header Signature)
• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Emailer Messages
• API
• Enrichment
• Search
• Accounts
• Contacts
• Deals
• Sequences
• Tasks
• Calls
• Conversations
• Analytics
• Miscellaneous

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime