YGOPRODeck · Schema

SearchMeta

Pagination metadata included when `num` and `offset` are used.

GamesTrading Card GamesYu Gi OhCard DatabaseOpen DataCommunity APIPublic APIs

Properties

Name Type Description
current_rows integer Number of rows in the current page.
total_rows integer Total number of rows matched by the query.
rows_remaining integer Rows remaining after this page.
total_pages integer Total number of pages.
pages_remaining integer Pages remaining after this one.
next_page string URL for the next page.
next_page_offset integer Offset value for the next page.
View JSON Schema on GitHub

JSON Schema

ygoprodeck-api-search-meta-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/yu-gi-oh/refs/heads/main/json-schema/ygoprodeck-api-search-meta-schema.json",
  "title": "SearchMeta",
  "description": "Pagination metadata included when `num` and `offset` are used.",
  "type": "object",
  "properties": {
    "current_rows": {
      "type": "integer",
      "description": "Number of rows in the current page.",
      "example": 20
    },
    "total_rows": {
      "type": "integer",
      "description": "Total number of rows matched by the query.",
      "example": 144
    },
    "rows_remaining": {
      "type": "integer",
      "description": "Rows remaining after this page.",
      "example": 124
    },
    "total_pages": {
      "type": "integer",
      "description": "Total number of pages.",
      "example": 8
    },
    "pages_remaining": {
      "type": "integer",
      "description": "Pages remaining after this one.",
      "example": 7
    },
    "next_page": {
      "type": "string",
      "format": "uri",
      "description": "URL for the next page."
    },
    "next_page_offset": {
      "type": "integer",
      "description": "Offset value for the next page."
    }
  }
}