/pixiv/novels/search

POST /api/pixiv/novels/search

Price: 5 credits

Search pixiv novels by tag or words, newest first: novel id, title, cover, tags, author, length, reading time, bookmarks, series, language and posting time

How to use it

Results are newest first. Pass an id to pixiv/novels for the full text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Tag or words to search for (examples: "原神", "ファンタジー"; minLength: 1)
• match string — Where the query must match (default: "tags_exact"; one of: "tags_exact", "tags_partial", "title_caption")
• exclude_ai boolean — Leave out novels flagged as AI-generated (default: false)
• created_from integer nullable — Earliest posting day, unix seconds (day-granular, UTC) (examples: 1704067200)
• created_to integer nullable — Latest posting day, unix seconds (day-granular, UTC) (examples: 1706659200)
• count integer required — Max number of results (min: 1; max: 300)

Response

• @type string (default: "PixivNovelCard")
• id string required
• url string required
• genre string nullable
• age_rating string nullable
• is_ai_generated boolean nullable
• cover string nullable
• description string nullable
• tags array (default: [])
• author object nullable
  • @type string (default: "PixivUserRef")
  • id string required
  • name string nullable
  • alias string nullable
  • image string nullable
  • url string required
• character_count integer nullable
• word_count integer nullable
• reading_time integer nullable
• bookmark_count integer nullable
• is_original boolean nullable
• is_unlisted boolean nullable
• is_masked boolean nullable
• language string nullable
• series object nullable
  • @type string (default: "PixivSeriesRef")
  • id string required
  • order integer nullable
  • url string nullable
• title_translation string nullable
• description_translation string nullable
• created_at integer nullable
• updated_at integer 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 — The entity was not found, or a precondition failed 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.