ORB Intelligence Authentication: API Key Guide (2026)

Authentication overview

ORB Intelligence provides access to its suite of company data APIs—including the Company Data API, Company Search API, and News & Events API—through a straightforward API key authentication mechanism. This method grants access to various endpoints for retrieving firmographic, technographic, and news data. The API key serves as a unique identifier and secret token, verifying the identity of the requesting application or user to the ORB Intelligence platform. All API interactions are expected to occur over HTTPS to ensure the confidentiality and integrity of both the API key and the data exchanged.

The API key model simplifies integration for developers by reducing the complexity often associated with more elaborate authentication flows like OAuth 2.0, while still providing a secure method for controlled access. It is suitable for server-to-server communication and applications where the API key can be securely stored and managed. ORB Intelligence's approach aligns with common practices for RESTful API authentication, emphasizing ease of use alongside essential security considerations for protecting sensitive business data.

Supported authentication methods

ORB Intelligence primarily supports API Key authentication for its API endpoints. This method is standard for many commercial APIs due to its simplicity and effectiveness in managing access to resources. When a request is made to the ORB Intelligence API, the provided API key is checked against the system's records to confirm its validity and the associated account's permissions. This process determines whether the request is authorized to access the requested data or functionality.

The API key is typically transmitted in a custom HTTP header or as a query parameter, though the header method is generally preferred for enhanced security by keeping the key out of server logs and browser history. Developers should consult the official ORB Intelligence API documentation for specific implementation details on how to pass the API key with each request.

Here's a summary of the authentication method:

While API keys offer simplicity, it is crucial to manage them with care to prevent unauthorized access. Best practices include storing keys as environment variables, using secret management services, and rotating keys periodically. The use of HTTPS for all API calls is mandatory to encrypt the API key in transit, protecting it from interception. This practice is a fundamental aspect of secure API communication, as detailed in general web security guidelines by organizations like the W3C Web Security FAQ.

Getting your credentials

To obtain your ORB Intelligence API key, you must first register for an account on the ORB Intelligence platform. Both the free Developer Plan and paid plans provide access to an API key. The process typically involves these steps:

1. Sign Up/Log In: Navigate to the ORB Intelligence website and either create a new account or log into an existing one.
2. Access Dashboard: Once logged in, locate your account dashboard. This is usually where you manage your subscription, monitor usage, and access developer resources.
3. Generate API Key: Within the dashboard, there will be a dedicated section for API access or developer settings. Here, you can typically generate or retrieve your unique API key. Some platforms provide the option to generate multiple keys for different applications or revoke existing keys.
4. Copy Key: Carefully copy your API key. It is a long string of alphanumeric characters. Treat this key as a sensitive password.

For the free Developer Plan, users receive 50 API requests per month. This tier allows developers to test the API's functionality and integrate it into their applications without immediate cost. Paid plans, such as the Starter Plan, begin at $99/month for 5,000 requests, offering higher limits and additional features. Regardless of the plan, the method for obtaining and using the API key remains consistent. Refer to the ORB Intelligence documentation for the most up-to-date instructions on credential retrieval.

Authenticated request example

Once you have obtained your API key, you can integrate it into your API requests. The ORB Intelligence API expects the API key to be passed in the X-Orb-API-Key HTTP header. Below are examples of how to make an authenticated request using cURL and Python, demonstrating the inclusion of the API key.

cURL Example

This cURL example demonstrates how to fetch company data by including your API key in the request header.

curl -X GET \
  'https://api.orbintelligence.com/0.1/company/?domain=google.com' \
  -H 'Accept: application/json' \
  -H 'X-Orb-API-Key: YOUR_API_KEY_HERE'

Replace YOUR_API_KEY_HERE with your actual API key obtained from your ORB Intelligence dashboard. This request targets the company endpoint to retrieve data for the domain google.com.

Python Example

The following Python example uses the requests library to make a similar authenticated API call. This approach is common for server-side applications and scripts.

import requests

api_key = 'YOUR_API_KEY_HERE'  # Replace with your actual API key
url = 'https://api.orbintelligence.com/0.1/company/?domain=google.com'

headers = {
    'Accept': 'application/json',
    'X-Orb-API-Key': api_key
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for HTTP errors (4xx or 5xx)
    company_data = response.json()
    print(company_data)
except requests.exceptions.RequestException as e:
    print(f"An error occurred: {e}")

In this Python snippet, the API key is stored in a variable and then passed within the headers dictionary. The requests.get() function sends the HTTP GET request, and response.json() parses the JSON response from the API. Error handling is included to catch potential network issues or API-specific errors.

These examples illustrate the fundamental method for authenticating requests to the ORB Intelligence API. For more detailed endpoint information and additional parameters, refer to the comprehensive ORB Intelligence API reference.

Security best practices

Securing your API key is critical to prevent unauthorized access to ORB Intelligence data and to maintain the integrity of your applications. Adhering to robust security practices helps protect your account from misuse and ensures compliance with data protection regulations like GDPR, which ORB Intelligence is compliant with.

1. Treat API Keys as Passwords: Your API key grants full access to your ORB Intelligence account's API capabilities. Never embed API keys directly into client-side code (e.g., JavaScript in a web browser) or publicly accessible repositories. If an API key is compromised, it can be used by malicious actors to consume your API quota or access your data.

2. Use Environment Variables or Secret Management: For server-side applications, store API keys as environment variables rather than hardcoding them into your source code. This practice prevents the key from being exposed if your code repository is compromised. For more complex deployments, consider using secret management services like AWS Secrets Manager, Google Secret Manager, or Azure Key Vault, which provide secure storage and retrieval of sensitive credentials.

3. Transmit Over HTTPS Only: Always ensure that all API requests to ORB Intelligence are made over HTTPS (HTTP Secure). HTTPS encrypts the communication channel between your application and the API server, protecting your API key and data from interception during transit. ORB Intelligence's API endpoints are designed to enforce HTTPS, but it is good practice to explicitly confirm your client is using it.

4. Implement IP Whitelisting (if available): If ORB Intelligence offers IP whitelisting, configure it to restrict API access only to a predefined set of trusted IP addresses belonging to your servers or network. This adds an extra layer of security, as even if an API key is stolen, it cannot be used from an unauthorized IP address.

5. Rotate API Keys Regularly: Periodically rotate your API keys. This means generating a new key and replacing the old one in your applications. Regular rotation minimizes the window of exposure if a key is ever compromised without your knowledge. Check your ORB Intelligence dashboard for instructions on how to rotate keys.

6. Monitor API Usage: Regularly review your API usage logs and metrics provided by ORB Intelligence. Unusual spikes in activity or requests from unexpected locations could indicate a compromised key. Prompt detection allows for quick action, such as revoking the compromised key.

7. Revoke Compromised Keys Immediately: If you suspect an API key has been compromised, revoke it immediately from your ORB Intelligence account dashboard. Generate a new key and update your applications accordingly.

8. Principle of Least Privilege: If ORB Intelligence offers granular permissions for API keys, assign only the minimum necessary permissions required for a specific application or service. This limits the potential damage if a key is compromised.

By following these best practices, developers can significantly enhance the security posture of their applications interacting with the ORB Intelligence API, safeguarding both their data and their API quota. For further guidance on secure credential management, resources like the Google Cloud security best practices provide general principles applicable across various API integrations.