Skip to content

JSON export format

Uwe Trottmann edited this page Jun 17, 2021 · 16 revisions

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

[
    {
        "content_rating": "MA",
        "country": "us", // two letter ISO 3166-1 alpha-2 country code
        "favorite": true,
        "first_aired": "2018-02-02T08:00:00Z", // ISO 8601 datetime string
        "hidden": false,
        "imdb_id": "tt2261227",
        "language": "en",
        "last_watched_ms": 1614593199175,
        "network": "Netflix",
        "notify": true,
        "poster": "/95IsiH4p5937YXQHaOS2W2dWYOG.jpg", // TMDb poster path
        "rating": 9.5, // 0.0 to 10.0
        "rating_user": 10, // 0, 1 to 10
        "rating_votes": 100,
        "release_time": 300, // Encoded 24 hour local time (hhmm)
        "release_timezone": "America/New_York", // tz database name (Olson)
        "release_weekday": 4, // Local release week day (1-7, 0 if daily, -1 if unknown)
        "runtime": 50, // in minutes
        "seasons": [
            {
                "episodes": [
                    {
                        "collected": false,
                        "episode": 1,
                        "first_aired": 1517558400000, // ms
                        "imdb_id": "",
                        "plays": 1,
                        "skipped": false,
                        "title": "Out of the Past",
                        "tmdb_id": 1401623,
                        "watched": true
                    }
                ],
                "season": 1,
                "tmdb_id": "81447"
            }
        ],
        "status": "canceled", // see JsonExportTask.ShowStatusExport
        "title": "Altered Carbon",
        "tmdb_id": 68421, // required, or set linked tvdb_id
        "trakt_id": 122265,
        "tvdb_id": 332331 // if tmdb_id not set, used to look it up
    }
]

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,
      "last_updated_ms":1529662832843
   },
   ...
]
Clone this wiki locally