Setup your Connections

All Shipp Platform API Endpoints are available under https://api.shipp.ai/api/v1. The API Uses API Keys for authentication as the query parameter ?api_key=shipp-live-123.

Create Connection¶

Create Connections by describing what games/teams/sports/events you want raw event data for.

The filter can also include an id of a specific game or team, if you only wanted events for that game/team.

  curl https://api.shipp.ai/api/v1/connections/create?api_key=<Your API Key> -d '{
    "filter_instructions": "Track all NBA games today and include scoring and play-by-play context"
  }'

const apiKey = "YOUR_API_KEY_HERE";
const url = `https://api.shipp.ai/api/v1/connections/create?api_key=${apiKey}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    filter_instructions: "Track all NBA games today and include scoring and play-by-play context"
  })
});

const result = await response.json();

import requests

url = "https://api.shipp.ai/api/v1/connections/create"
api_key = "YOUR_API_KEY_HERE"

params = {
    "api_key": api_key
}

payload = {
    "filter_instructions": "Track all NBA games today and include scoring and play-by-play context"
}

response = requests.post(url, json=payload, params=params)

This should return a 200 status code

{
  "connection_id": "01KFXTX1WDQ68A1GS77T1XJ5YB",
  "enabled": true,
  "name": "NBA Today",
  "description": "Raw event feed for NBA games today"
}

When to use Create Connection¶

Prefer using create connection at build time to reduce unecessary costs. There is also a time overhead, usually unacceptable for user interactions. This overhead enables us to provide lightning fast data responses.

This connection will remain valid, so long as the filters work for new events.

List the new Connection¶

Now you can list the new connection. This endpoint is free to call, so you can always list your connections created. If decided not to save connection_ids, this is an easy way to lookup an existing connection to use.

  curl https://api.shipp.ai/api/v1/connections?api_key=<Your API Key>

const apiKey = "YOUR_API_KEY_HERE";
const url = `https://api.shipp.ai/api/v1/connections?api_key=${apiKey}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  },
});

const result = await response.json();

import requests

url = "https://api.shipp.ai/api/v1/connections"
api_key = "YOUR_API_KEY_HERE"

params = {
    "api_key": api_key
}

response = requests.get(url, params=params)

which returns

{
  "connections": [
    {
      "connection_id": "01KFXTX1WDQ68A1GS77T1XJ5YB",
      "enabled": true,
      "name": "NBA Today",
      "description": "Raw event feed for NBA games today"
    }
  ]
}