Client APIs
At its core, SyncTV is an API driven service. The APIs themselves are easy enough for developers to understand, but understanding the ecosystem is a little trickier. We've created the following tutorials to help you get your head around it.

Topics:

  • Info

This document describes the API for viewing the currently authorized account's geo IP data.

Actions

Url:

  • [GET] /api/v2/info/request_ip.[xml|json]

Returns a requests ip info.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
Example Request

[GET] https://service_name.synctv.com/api/v2/info/request_ip.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <request>
    <ip>127.0.0.1</ip>
    <country_code>N/A</country_code>
    <country_code2>N/A</country_code2>  
    <country_code3>N/A</country_code3>
    <country_name>N/A</country_name>
    <continent_code>N/A</continent_code>
  </request>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>
Response Fields:
  • (String) ip
    The IP of the currently authorized account.
  • (String) country_code
    The country code (ISO 3166-1 numeric) of the requesting IP.
  • (String) country_code2
    The two character country code (ISO 3166-1 alpha-2) of the requesting IP.
  • (String) country_code3
    The three character country code (ISO 3166-1 alpha-3) of the requesting IP.
  • (String) country_name
    The name of the country associated with the requesting IP (ISO 3166).
  • (String) continent_code
    The two character continent code (ISO 3166) of the requesting IP.

Url:

  • [GET] /api/v2/info/server_status.[xml|json]

Returns the server status, for the main server as well as the database and memcache server.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
Example Request

[GET] https://service_name.synctv.com/api/v2/info/server_status.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (String)
Example Response
XML JSON

<response>
  <request>
    <server_stats>true</server_stats>
    <database>true</database>
    <memcache>true</memcache>
  </request>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>
Response Fields:
  • (String) server_stats
    (True = Online, False = Offline)
  • (String) database
    (True = Online, False = Offline)
  • (String) memcache
    (True = Online, False = Offline)