Getting started overview

This guide provides a structured approach to initiating development with uNoGS, a service designed for querying global streaming content availability. The process covers essential steps from account creation to executing a preliminary API request. uNoGS focuses on providing data related to what's available on Netflix across different regions, tracking content availability changes, and assisting in identifying content that may be accessible via VPNs.

Before making your first API call, you will complete three main stages:

  1. Account Creation: Registering on the uNoGS platform.
  2. API Key Retrieval: Locating and securing your unique API key.
  3. First Request Execution: Constructing and sending a basic API call to verify connectivity and authentication.

This page assumes basic familiarity with making HTTP requests and handling JSON data. For a broader understanding of RESTful API principles, consult resources such as the Red Hat explanation of REST APIs.

Quick reference steps

The following table summarizes the initial steps to get started with uNoGS:

Step What to do Where
1. Create Account Register for a free uNoGS account. uNoGS registration page
2. Get API Key Locate your personal API key in your account dashboard. uNoGS account dashboard
3. Make First Request Use a tool like cURL or Postman to send a GET request with your API key. Your development environment
4. Parse Response Check the JSON response for expected data or error messages. Your development environment

Create an account and get keys

To begin using the uNoGS API, you must first create an account on their platform. This registration process is free and grants you access to your unique API key, which is essential for authenticating your requests.

Account registration

  1. Navigate to the official uNoGS registration page.
  2. Provide the required information, typically an email address and a password.
  3. Complete any verification steps, such as email confirmation, as prompted.
  4. Once registered, log in to your new uNoGS account.

API key retrieval

After successfully logging in, your API key will be accessible from your account dashboard:

  1. From the uNoGS homepage, click on the "Account" or "Dashboard" link, typically found in the navigation bar or user menu.
  2. On your uNoGS account dashboard, locate the section labeled "API Key" or similar.
  3. Your API key will be displayed. It is a unique alphanumeric string.
  4. Copy this key securely. Treat your API key like a password; do not expose it in public repositories or client-side code.

The uNoGS API key serves as your credential for authenticating API requests. Without it, your requests will likely be rejected with an authentication error. The key is typically passed in a custom HTTP header, as is common practice for many RESTful APIs, as outlined in AWS API Gateway API key documentation.

Your first request

With your account created and API key retrieved, you can now make your first authenticated request to the uNoGS API. This example demonstrates querying for a list of available titles.

API endpoint

A common starting point for uNoGS is querying for titles. The base URL for the API is https://unogs.com/api, and a typical endpoint might be /api/search or /api/title, depending on the specific query. For demonstration, we'll use a generic search endpoint.

Authentication method

uNoGS typically expects the API key to be sent in a custom HTTP header. A common header name is X-RapidAPI-Key if integrated through a platform like RapidAPI, or a custom header specified by uNoGS if direct. For this example, we'll assume a header named X-API-KEY.

Example request with cURL

Using cURL, a command-line tool for making HTTP requests, you can construct your first API call. Replace YOUR_API_KEY with the key you obtained from your uNoGS account dashboard.

curl -X GET \
  'https://unogs.com/api/search?query=the+office&country=us' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -H 'Accept: application/json'

This cURL command performs the following actions:

  • -X GET: Specifies an HTTP GET request.
  • 'https://unogs.com/api/search?query=the+office&country=us': The target API endpoint, searching for "the office" in the US region.
  • -H 'X-API-KEY: YOUR_API_KEY': Sets the custom HTTP header for authentication.
  • -H 'Accept: application/json': Indicates that the client prefers a JSON response.

Expected response

A successful response will typically return a JSON object containing an array of titles matching your query, along with metadata such as availability, synopsis, and region-specific details. An example of a successful (but truncated) JSON response might look like this:

{
  "results": [
    {
      "title": "The Office (US)",
      "netflixid": 70136112,
      "country_code": "us",
      "available_regions": ["us", "ca", "uk"],
      "synopsis": "A mockumentary on a group of typical office workers..."
    },
    {
      "title": "The Office (UK)",
      "netflixid": 70136113,
      "country_code": "us",
      "available_regions": ["us", "ca"],
      "synopsis": "A British comedy series..."
    }
  ],
  "total_results": 2
}

If your API key is invalid or missing, or if there's an issue with the request, you will receive an error response, typically with an HTTP status code indicating the problem (e.g., 401 Unauthorized or 403 Forbidden).

Common next steps

After successfully making your initial API call, consider these next steps to further integrate uNoGS into your application:

  • Explore Endpoints: Consult the uNoGS API documentation (accessible from your account dashboard) to understand the full range of available endpoints and their specific parameters. This includes endpoints for searching by title, region, genre, and more.
  • Implement Error Handling: Integrate robust error handling into your code to gracefully manage scenarios such as invalid API keys, rate limits, or malformed requests. This often involves checking HTTP status codes and parsing error messages from the API response.
  • Manage Rate Limits: Be aware of any rate limits imposed by uNoGS. Many free APIs have restrictions on the number of requests you can make within a given timeframe. Implement a strategy to handle these, such as exponential backoff, to avoid being temporarily blocked.
  • Data Parsing and Storage: Develop logic to parse the JSON responses and extract the specific data points relevant to your application. Depending on your use case, you might store this data in a database or cache it for performance.
  • Build User Interface: If you are building a user-facing application, design a user interface that effectively displays the retrieved content availability information, potentially allowing users to filter or sort results.
  • Stay Updated: Periodically check the uNoGS official website for API updates, new features, or changes to existing endpoints.

Troubleshooting the first call

Encountering issues during your first API call is common. Here are some troubleshooting steps:

  • Check API Key: Double-verify that your API key is correct and has been copied accurately. Even a single character mismatch can cause authentication failures.
  • Verify Header Name: Ensure the HTTP header name used for your API key is precisely what uNoGS expects (e.g., X-API-KEY, X-RapidAPI-Key). Refer to the official uNoGS API documentation for the exact header name.
  • Inspect HTTP Status Codes:
    • 401 Unauthorized or 403 Forbidden: Typically indicates an issue with your API key or authentication.
    • 400 Bad Request: Often means there's an issue with your request parameters (e.g., missing required parameters, incorrect values).
    • 404 Not Found: The endpoint you are trying to reach might not exist or the URL is incorrect.
    • 429 Too Many Requests: You have hit a rate limit. Wait for some time before retrying.
  • Review Endpoint URL: Confirm that the base URL and the specific endpoint path are correct, including any query parameters.
  • Examine Request Body/Parameters: If your request involves a body (for POST/PUT requests, though GET is common for uNoGS), ensure its format (e.g., JSON) and content are valid. For GET requests, check query parameters.
  • Use a REST Client: Tools like Postman or Insomnia can help in constructing and debugging API requests interactively, providing better visibility into headers, bodies, and responses than raw cURL commands. The Postman desktop client is a widely used option.
  • Consult uNoGS Documentation: The most authoritative source for troubleshooting specific API behaviors and error messages is the official uNoGS API documentation, usually linked from your account dashboard.