API DOCUMENTATION - SponsorPitch Getting Started Guide

Welcome to the API documentation of SponsorPitch's Rest v1 API. The SponsorPitch API offers an easy way to pull SponsorPitch’s real-time sponsorship deal data in an automated, customizable way. Using the following API protocols, developers can access our extensive database of sponsorship deals between sponsors and properties (events) and construct a custom data set that is most valuable to their team. This version of the API is architected around REST using standard HTTP access verbs.

API MAPPING

base uri: https://sponsorpitch.com/api/v1

This API provides access to all of SponsorPitch's deals and relevant information therein for the preceding 12 month period.

URL Verb Functionality
/deals GET This is to get all deals

API AUTHENTICATION

In order to make API calls, you must authenticate each call by passing your Authentication token and API ID value with each call within the header. This will simplify the calls for your benefit.

Header Value
X-AUTHENTICATION_TOKEN X-API_ID Your authentication token and api id

GET DEALS

/deals

Using the API you may parse the deal data on a number of levels including

property name, sponsor name, property genre, property sub-genre, sponsor category, sponsor sub-category, date signed and location.
Fields DataType Description
start_date end_date string If only start date is provided, end date will be today's date.
activation_location string cities/markets that the deal affects
sponsors string name of a sponsor
properties string name of a property
categories string category of a sponsor
subcategories string subcategories of a sponsor
genres string genre of a property
subgenres string subgenres of a property

Example Response

    {"status":"OK",
    "deals":[
            {
                "id":33300,
                "sponsor":"Under Armour",
                "property":"Yale Bulldogs",
                "category":"Athletic Apparel & Equipment",
                "sub_category":"Apparel",
                "genre":"Collegiate Athletics",
                "subgenre":"Education",
                "date_signed":"2016-01-01",
                "activation_location":"New Haven",
                "estimated_fee_per_year":1600000.0,
                "deal_length": 10.0
            },
            {
                "id":30516,
                "sponsor":"Koss",
                "property":"Milwaukee Film Festival",
                "category":"Audio Equipment",
                "sub_category":"Consumer Electronics",
                "genre":"Film Festival",
                "subgenre":"Fairs and Festivals",
                "date_signed":"2015-08-01",
                "activation_location":"Milwaukee",
                "estimated_fee_per_year":30000.0,
                "deal_length": 1.0
            },
            {
                "id":32412,
                "sponsor":"Sprint",
                "property":"Chicago Transport Authority",
                "category":"Wireless Services",
                "sub_category":"Telecommunication",
                "genre":"Cities",
                "subgenre":"Municipal Properties",
                "date_signed":"2015-11-01",
                "activation_location":"Chicago",
                "estimated_fee_per_year":300000.0,
                "deal_length": 1.0
            }
        ]   
    }