Skip to main content

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:

Parameter Type Description
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
api_key_credentials ApiKeyCredentials The credential object for Custom Header Signature
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-apollo-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apimatic-apollo-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_apollo_sdk-0.0.1.tar.gz 359.5 kB Without provenance Details for apimatic_apollo_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-apollo-sdk 0.0.1
File Interpreter ABI Platform Actions
apimatic_apollo_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for apimatic_apollo_sdk-0.0.1-py3-none-any.whl

Total release size: 1.1 MB

Release files / apimatic_apollo_sdk-0.0.1.tar.gz

Download URL apimatic_apollo_sdk-0.0.1.tar.gz
Size 359.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a45fbc6a35177d23c75b145da4ea865b9af43990a797adfc9b353686a8babece
BLAKE2b-256 checksum
How to use checksums
f64289cb6b9dc83e68d9e0208a28d8b6783d83b06516a501f604a255b403417a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_apollo_sdk-0.0.1-py3-none-any.whl

Download URL apimatic_apollo_sdk-0.0.1-py3-none-any.whl
Size 770.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d657cc9ac38d535b034ae232fca92184dcf261a442d3a472110a695e18ddaac1
BLAKE2b-256 checksum
How to use checksums
b9c9e9b2f2fb5383a4d06876b8ca2f85139bdc47f8b6c767ea2bf92bb81038c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-apollo-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page