Danbooru
Login Posts Comments Notes Artists Tags Pools Wiki Forum More ยป
Search Changes Help | Posts (0) History
  • Help
guro
scat
furry -rating:g

Recent Changes (all)

  • miltie (kanan-sama)
  • miel (kanan-sama)
  • rapi (red hood) (red flavor) (nikke)
  • ami (kanan-sama)
  • jeanne (kanan-sama)
  • kanan-sama wa akumade choroi
  • kyougi youji
  • picologil
  • kougyaku reiki
  • exs-tia azarin
  • ganusgil
  • alchegil (exs-tia)
  • stella (pokemon)
  • kuruoka emi
  • haiba 09
  • itachi shiro
  • track jacket
  • blazer
  • jacket over swimsuit
  • sensei to mondaiji? no yuri
  • juniper actias (full moon)
  • edwin riefenstahl
  • kochou jigoku
  • dogma (the binding of isaac)
  • grimrian

Options

  • Wiki History
  • Discussions
  • What Links Here

api:tags

Table of Contents
  • 01. Record field format
  • 02. Associated attributes
  • 03. Nomenclature
  • 04. Index
  • 05. Show
  • 06. Update
  • 07. See also
  • 08. External links

The following includes the details of how to interface with the tag records through the API.

Record field format

NameTypeDetails
idinteger>0
namestring
categoryintegerincludes [0,1,3,4,5]
post_countinteger>=0
is_deprecatedboolean
created_attimestamp
updated_attimestamp
Category
ValueDescription
0General
1Artist
3Copyright
4Character
5Meta

Associated attributes

NameTypeNumberAvailabilityDetails
wiki_pagewiki pagesingleoptionalWiki page whose title matches the tag name.
artistartistsingleoptionalArtist whose name matches the tag name.
antecedent_aliastag aliassingleoptionalAlias where the tag is the antecedent.
consequent_aliasestag aliasmultipleoptionalAliases where the tag is the consequent.
antecedent_implicationstag implicationmultipleoptionalImplications where the tag is the antecedent.
consequent_implicationstag implicationmultipleoptionalImplications where the tag is the consequent.
dtext_linksdtext linkmultipleoptionalDtext links to the page whose title matches the tag name.

Nomenclature

  • Plural form: "tags"
    • Used in the URL pathname
  • Singular form: "tag"
    • Used for write parameters (Help:API Write Requests)
  • Versions: none

Index

HTTP MethodGET
Base URL/tags.json
Typeread request
DescriptionThe default order is ID descending.
Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

  • Number syntax
    • id
    • category
    • post_count
    • created_at
    • updated_at
  • Text syntax
    • name
  • Boolean syntax
    • is_deprecated
  • Chaining syntax
    • wiki_page
    • artist
    • antecedent_alias
    • consequent_aliases
    • antecedent_implications
    • consequent_implications
    • consequent_implications
    • dtext_links
Special search parameters
  • fuzzy_name_matches - Shows tags with names that are within a certain percentage of similarity.
  • name_matches - Normalized wildcard search on the name field.
  • name_normalize - Normalized wildcard search on the name field that supports multiple tags split by a comma ",".
  • name_or_alias_matches - Normalized wildcard search on the name field that also checks for aliases where the search term is the antecedent.
  • hide_empty - Shows only tags that have a post count greater than 0 (Help:Boolean syntax).
Search order

Using the search parameter order with one of the following values changes the order of the results.

  • name - Alphabetical order on the name.
  • date - Orders by ID descending.
  • count - Orders by post count.
  • similarity - Orders by similarity to the search term.
    • Only when the fuzzy_name_matches parameter is used.

Show

HTTP MethodGET
Base URL/tags/$id.json
Typeread request
Description$id is the tag ID.

Update

HTTP MethodPUT/PATCH
Base URL/tags/$id.json
Typewrite request
Description$id is the tag ID.
Update parameters
  • Optional:
    • is_deprecated
      • can only be set to false by admins
      • can only be set to true if the tag has a wiki page, and either its post count is zero or the user is an admin
    • category Restricted by user level
      • Member+: < 50 posts
      • Builder+: < 1000 posts
      • Admin+: No limit

See also

  • Help:Common URL Parameters
  • Help:API

External links

Controllerhttps://github.com/danbooru/danbooru/blob/master/app/controllers/tags_controller.rb
Modelhttps://github.com/danbooru/danbooru/blob/master/app/models/tag.rb
Policyhttps://github.com/danbooru/danbooru/blob/master/app/policies/tag_policy.rb
Terms / Privacy / Upgrade / Contact /