Quickstart

This guide will walk you through making your first request to the Poix API. We’ll cover authentication and a simple API call to get you started.

Step 1: Create Your Token

Login to a Poix account if you haven’t already.
Navigate to the Tokens page in the dashboard.
Create a new Token and copy it. Keep this key secure and don’t share it publicly.

Step 2: Authentication

Poix uses Tokens for authentication. Include your Token in the Authorization header of your requests:

Authorization: Bearer YOUR_TOKEN

Step 3: Make Your First API Request

Let’s make a simple request to get information about a YouTube video. We’ll use the /search endpoint for this example. Replace YOUR_TOKEN with your actual Token.

curl --request GET \
  --url https://api.poix.io/search \
  --header 'Authorization: Bearer YOUR_TOKEN'

import requests

url = "https://api.poix.io/search"

headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.request("GET", url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_TOKEN',
  },
};

fetch('https://api.poix.io/search', options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

If successful, you’ll receive a JSON response with details:

{
    "regionCode": "US",
    "totalResults": 1000000,
    "resultsPerPage": 10,
    "nextPageToken": "CAoQAA",
    "data": [
        {
            "kind": "youtube#video",
            "videoId": "VZ91YQ8yhkY",
            "publishedAt": "2024-09-25T17:00:21Z",
            "channelId": "UCtXn8EDGHrAL9gLppoHZXSg",
            "title": "Super Weird Things Only MALE Cats Do For Their",
           // ... other details

Next Steps

Congratulations! You’ve made your first request to the Poix API. Here are some next steps:

Explore the API Reference to learn about other endpoints.
Check out our Guides for best practices and advanced usage.
If you have any questions, contact support.

Happy coding!

Get Started

Dashboard

Step 1: Create Your Token

Step 2: Authentication

Step 3: Make Your First API Request

Next Steps

​Step 1: Create Your Token

​Step 2: Authentication

​Step 3: Make Your First API Request

​Next Steps

Step 1: Create Your Token

Step 2: Authentication

Step 3: Make Your First API Request

Next Steps