/niconico/series

POST /api/niconico/series

Price: 5 credits

Get Niconico series details and its videos by ID or URL

How to use it

Get a Niconico (nicovideo.jp) series by ID or URL. Returns series metadata (title, owner, video count) and the ordered list of videos with per-video counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• series string required — Niconico series ID or series URL (examples: "145952", "https://www.nicovideo.jp/series/145952"; minLength: 1)

Response

• @type string (default: "NiconicoSeries")
• id integer required
• series_title string nullable
• description string nullable
• url string required
• image string nullable
• owner object nullable
  • @type string (default: "NiconicoOwner")
  • id string required
  • name string nullable
  • owner_type string nullable
  • image string nullable
  • url string nullable
• video_count integer nullable
• created_at integer nullable
• updated_at integer nullable
• videos array (default: [])
  • @type string (default: "NiconicoVideoCard")
  • id string required
  • video_title string nullable
  • url string required
  • content_type string nullable
  • description string nullable
  • duration_seconds integer nullable
  • view_count integer nullable
  • comment_count integer nullable
  • mylist_count integer nullable
  • like_count integer nullable
  • registered_at integer nullable
  • image string nullable
  • latest_comment string nullable
  • is_channel_video boolean (default: false)
  • is_payment_required boolean (default: false)
  • owner object nullable
    • @type string (default: "NiconicoOwner")
    • id string required
    • name string nullable
    • owner_type string nullable
    • image string nullable
    • url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Series not found. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.