JSON export format

Uwe Trottmann edited this page Nov 18, 2016 · 7 revisions
Clone this wiki locally

SeriesGuide can export and import your data using JSON text files. Their format is documented here.

The actual exported JSON is written without indents and comments to save space and increase performance. The following representation is for documentation purposes only.

When importing, not all but a few required values need to be present. SeriesGuide will in most cases fill in missing values on the next update.

Shows

File name: sg-shows-export.json

[
  {
    "tvdb_id":248741, // TheTVDB show id, required
    "country":"us", // ISO 3166-1 alpha-2 two letter country code
    "release_time":2000, // Encoded 24 hour local time (hhmm)
    "release_timezone":"America/New_York", // tz database name (Olson)
    "release_weekday":1, // See org.joda.time.DateTimeConstants
    "actors":"|Beth Behrs|Kat Dennings|",
    "content_rating":"TV-14",
    "favorite":false,
    "first_aired":"2011-09-20T00:00:00.000Z",
    "genres":"|Comedy|",
    "hidden":false,
    "imdb_id":"tt1845307",
    "last_edited":1430256880, // From TheTVDB, in seconds
    "last_updated":1430296309940,
    "last_watched_episode":5007198, // TheTVDB id of the episode
    "last_watched_ms":1430296309940, // used to determine last watched order
    "language":en, // preferred content language to fetch from TheTVDB
    "network":"CBS",
    "overview":"A lot of girls move to New York City to \"make it\".",
    "poster":"posters/248741-6.jpg", // TheTVDB banner path
    "rating":7.70957,
    "rating_user":9,
    "rating_votes":5541,
    "runtime":30,
    "status":"continuing",
    "title":"2 Broke Girls",
    "trakt_id":123, // only if the show is listed on trakt
    "seasons":[
      {
        "season":0, // 0 for Special Episodes, 1-n regular seasons
        "tvdb_id":465947,
        "episodes":[
          {
            "collected":true,
            "directors":"Don Scardino",
            "episode":1,
            "episode_absolute":49,
            "episode_dvd":1.0,
            "first_aired":1379980800000,
            "gueststars":"Eric Tiede|Darren Darnborough",
            "image":"episodes/248741/4595689.jpg", // TheTVDB episode image path
            "imdb_id":"tt2801464",
            "last_edited":1426450001, // From TheTVDB, in seconds
            "overview":"Word about a shocking incident.",
            "rating":0.0,
            "rating_user":0,
            "rating_votes":0,
            "skipped":false,
            "title":"And the Soft Opening",
            "tvdb_id":4595689,
            "watched":true,
            "writers":"Michael Patrick King"
          }
        ]
      },
      ...
    ]
  }
]

Lists

File name: sg-lists-export.json

[  
  {  
    "list_id":"firstlist",
    "name":"First list",
    "order":1,
    "items":[  
      {  
        "list_item_id":"248741-1-firstlist",
        "tvdb_id":248741,
        "type":"show"
      },
      {  
        "list_item_id":"522810-2-firstlist",
        "tvdb_id":522810,
        "type":"season"
      },
      {  
        "list_item_id":"4791401-3-firstlist",
        "tvdb_id":4791401,
        "type":"episode"
      }
    ]
  },
  ...
]

Movies

File name: sg-movies-export.json

[
   {  
      "tmdb_id":231576,
      "imdb_id":"tt2870708",
      "title":"Wish I Was Here",
      "overview":"Something, something, dark side.",
      "poster":"/8b54J6gCM27QodPBoBWAcC9JHnd.jpg", // TMDb poster path
      "released_utc_ms":1389999600000,
      "runtime_min":120,
      "in_collection":false,
      "in_watchlist":true,
      "watched":false
   },
   ...
]