api/v1/json/forums/:short_name/topics/:topic_slug/postsįetches a list of post responses for the abbreviated forum name given by the short_name and topic given by topic_slug URL parameters. api/v1/json/forums/dis/topics/ask-the-mods-anything api/v1/json/forums/:short_name/topics/:topic_slugįetches a topic response for the abbreviated forum name given by the short_name and topic given by topic_slug URL parameters. Returns image responses based on the results of reverse-searching the image given by the url query parameter.įetches a forum response for the abbreviated name given by the short_name URL parameter.įetches a list of topic responses for the abbreviated forum name given by the short_name URL parameter. api/v1/json/search/tags?q=analyzed_name:wing Key, filter_id, page, per_page, q, sd, sfĮxecutes the search given by the q query parameter, and returns image responses.Įxecutes the search given by the q query parameter, and returns tag responses sorted by descending image count. api/v1/json/search/posts?q=subject:time wasting thread api/v1/json/search/galleries?q=title:mean*Įxecutes the search given by the q query parameter, and returns post responses sorted by descending creation time. api/v1/json/search/comments?q=image_id:1000000Įxecutes the search given by the q query parameter, and returns gallery responses sorted by descending creation time. If no key is given or it is invalid, will return a 403 Forbidden error.įetches an oEmbed response for the given app link or CDN URL.Įxecutes the search given by the q query parameter, and returns comment responses sorted by descending creation time. The tag's ID is not used.įetches a post response for the post ID given by the post_id URL parameter.įetches a profile response for the user ID given by the user_id URL parameter.įetches a filter response for the filter ID given by the filter_id URL parameter.įetches a list of filter responses that are flagged as being system filters (and thus usable by anyone).įetches a list of filter responses that belong to the user given by key. įetches an image response for the for the current featured image.įetches a tag response for the tag slug given by the tag_id URL parameter. Methodįetches a comment response for the comment ID referenced by the comment_id URL parameter.įetches an image response for the image ID referenced by the image_id URL parameter. For the purposes of this document, a brief overview is given. The interested reader may find the implementations of these endpoints here. The current sort field, if the request is a search request. The current sort direction, if the request is a search request. The current search query, if the request is a search request. Empty values default to the first page.Ĭontrols the number of results per page, up to a limit of 50, if the response is paginated. You can find your authentication token in your account settings.Ĭontrols the current page of the response, if the response is paginated. If omitted, no user will be authenticated. This is primarily useful for unauthenticated API access.Īn optional authentication token. NameĪssuming the user can access the filter ID given by the parameter, overrides the current filter for this request. Not all parameters may be used in every request. This is a list of general parameters that are useful when working with the API. The https: protocol must be specified on all URLs. A link to the Derpibooru page is optional but recommended we recommend the domain as a canonical domain. If images are used, the artist must always be credited (if provided) and the original source URL must be displayed alongside the image, either in textual form or as a link. Your client must gracefully back off if requests fail, preferably exponentially or fatally. Your application must properly cache, and respect server-side cache expiry times. Users making abusively high numbers of requests or excessively expensive requests will be asked to stop, and banned if they do not. Consider if these suit your needs first, then rely on the API if they do not. Note that if you are looking to continuously scrape the entire website, we offer nightly database dumps instead. Derpibooru provides a JSON API for major site functionality, which can be freely used by anyone wanting to produce tools for the site or other web applications that use the data provided within Derpibooru.
0 Comments
Leave a Reply. |