Vocadb

VocaDbWeb

VocaDbWeb endpoints from Vocadb

Media & content#openapi#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

VocaDbWeb endpoints from Vocadb

Endpoints 129

ActivityEntryApi

  • GETGET /api/activityEntries/api/activityEntries?before=2024-01-01T00:00:00Z&since=2024-01-01T00:00:00Z&userId=0&editEvent=Created&entryType=Undefined&maxResults=50&getTotalCount=false&fields=None&entryFields=None&lang=Default&sortRule=CreateDateDescending

AlbumApi

  • GETGET /api/albums/api/albums?query=&discTypes=Unknown&tagName[]=string&tagId[]=0&childTags=false&artistId[]=0&artistParticipationStatus=Everything&childVoicebanks=false&includeMembers=false&barcode=string&status=Draft&releaseDateAfter=2024-01-01T00:00:00Z&releaseDateBefore=2024-01-01T00:00:00Z&advancedFilters={"filterType":"Nothing","negate":true,"param":"string"}&start=0&maxResults=10&getTotalCount=false&sort=None&preferAccurateMatches=false&deleted=false&nameMatchMode=Auto&fields=None&lang=Default
  • POSTPOST /api/albums/comments/{commentId}/api/albums/comments/:commentId
  • DELETEDELETE /api/albums/comments/{commentId}/api/albums/comments/:commentId
  • GETGET /api/albums/names/api/albums/names?query=&nameMatchMode=Auto&maxResults=15
  • GETGET /api/albums/new/api/albums/new?languagePreference=Default&fields=None
  • GETGET /api/albums/top/api/albums/top?ignoreIds[]=0&languagePreference=Default&fields=None
  • GETGET /api/albums/{id}/api/albums/:id?fields=None&songFields=None&lang=Default
  • DELETEDELETE /api/albums/{id}/api/albums/:id?notes=
  • GETGET /api/albums/{id}/comments/api/albums/:id/comments
  • POSTPOST /api/albums/{id}/comments/api/albums/:id/comments
  • GETGET /api/albums/{id}/reviews/api/albums/:id/reviews?languageCode=string
  • POSTPOST /api/albums/{id}/reviews/api/albums/:id/reviews
  • DELETEDELETE /api/albums/{id}/reviews/{reviewId}/api/albums/:id/reviews/:reviewId
  • GETGET /api/albums/{id}/tracks/api/albums/:id/tracks?fields=None&lang=Default
  • GETGET /api/albums/{id}/tracks/fields/api/albums/:id/tracks/fields?field[]=string&discNumber=0&lang=Default
  • GETGET /api/albums/{id}/user-collections/api/albums/:id/user-collections?languagePreference=Default

ArtistApi

  • GETGET /api/artists/api/artists?query=&artistTypes=string&allowBaseVoicebanks=true&tagName[]=string&tagId[]=0&childTags=false&followedByUserId=0&status=Draft&advancedFilters={"filterType":"Nothing","negate":true,"param":"string"}&start=0&maxResults=10&getTotalCount=false&sort=None&preferAccurateMatches=false&nameMatchMode=Auto&fields=None&lang=Default
  • POSTPOST /api/artists/comments/{commentId}/api/artists/comments/:commentId
  • DELETEDELETE /api/artists/comments/{commentId}/api/artists/comments/:commentId
  • GETGET /api/artists/names/api/artists/names?query=&nameMatchMode=Auto&maxResults=15
  • GETGET /api/artists/{id}/api/artists/:id?fields=None&relations=None&lang=Default
  • DELETEDELETE /api/artists/{id}/api/artists/:id?notes=
  • GETGET /api/artists/{id}/comments/api/artists/:id/comments
  • POSTPOST /api/artists/{id}/comments/api/artists/:id/comments

CommentApi

  • GETGET /api/comments/api/comments?before=2024-01-01T00:00:00Z&since=2024-01-01T00:00:00Z&userId=0&entryType=Undefined&maxResults=50&getTotalCount=false&fields=None&entryFields=None&lang=Default&sortRule=CreateDateDescending
  • GETGET /api/comments/{entryType}-comments/api/comments/:entryType-comments?entryId=0
  • POSTPOST /api/comments/{entryType}-comments/api/comments/:entryType-comments
  • POSTPOST /api/comments/{entryType}-comments/{commentId}/api/comments/:entryType-comments/:commentId
  • DELETEDELETE /api/comments/{entryType}-comments/{commentId}/api/comments/:entryType-comments/:commentId

DiscussionApi

  • POSTPOST /api/discussions/comments/{commentId}/api/discussions/comments/:commentId
  • DELETEDELETE /api/discussions/comments/{commentId}/api/discussions/comments/:commentId
  • GETGET /api/discussions/folders/api/discussions/folders?fields=None
  • POSTPOST /api/discussions/folders/api/discussions/folders
  • GETGET /api/discussions/folders/{folderId}/topics/api/discussions/folders/:folderId/topics?fields=NoneDeprecated.
  • POSTPOST /api/discussions/folders/{folderId}/topics/api/discussions/folders/:folderId/topics
  • GETGET /api/discussions/topics/api/discussions/topics?folderId=0&start=0&maxResults=10&getTotalCount=false&sort=None&fields=None
  • GETGET /api/discussions/topics/{topicId}/api/discussions/topics/:topicId?fields=None
  • POSTPOST /api/discussions/topics/{topicId}/api/discussions/topics/:topicId
  • DELETEDELETE /api/discussions/topics/{topicId}/api/discussions/topics/:topicId
  • POSTPOST /api/discussions/topics/{topicId}/comments/api/discussions/topics/:topicId/comments

EntryApi

  • GETGET /api/entries/api/entries?query=&tagName[]=string&tagId[]=0&childTags=false&entryTypes=Nothing&status=Draft&start=0&maxResults=10&getTotalCount=false&sort=None&nameMatchMode=Auto&fields=None&lang=Default
  • GETGET /api/entries/names/api/entries/names?query=&nameMatchMode=Auto&maxResults=10

EntryTypesApi

  • GETGET /api/entry-types/{entryType}/{subType}/tag/api/entry-types/:entryType/:subType/tag?fields=None

PVApi

  • GETGET /api/pvs/for-songs/api/pvs/for-songs?name=string&author=string&service=NicoNicoDouga&maxResults=10&getTotalCount=false&lang=Default

ReleaseEventSeriesApi

  • GETGET /api/releaseEventSeries/api/releaseEventSeries?query=&fields=None&start=0&maxResults=10&getTotalCount=false&nameMatchMode=Auto&lang=Default
  • GETGET /api/releaseEventSeries/{id}/api/releaseEventSeries/:id?fields=None&lang=Default
  • DELETEDELETE /api/releaseEventSeries/{id}/api/releaseEventSeries/:id?notes=&hardDelete=false
  • GETGET /api/releaseEventSeries/{id}/for-edit/api/releaseEventSeries/:id/for-edit

ReleaseEventApi

  • GETGET /api/releaseEvents/api/releaseEvents?query=&nameMatchMode=Auto&seriesId=0&afterDate=2024-01-01T00:00:00Z&beforeDate=2024-01-01T00:00:00Z&category=Unspecified&userCollectionId=0&tagId[]=0&childTags=false&artistId[]=0&childVoicebanks=false&includeMembers=false&status=Draft&start=0&maxResults=10&getTotalCount=false&sort=None&fields=None&lang=Default&sortDirection=Ascending
  • GETGET /api/releaseEvents/names/api/releaseEvents/names?query=&maxResults=10
  • GETGET /api/releaseEvents/{eventId}/albums/api/releaseEvents/:eventId/albums?fields=None&lang=Default
  • GETGET /api/releaseEvents/{eventId}/published-songs/api/releaseEvents/:eventId/published-songs?fields=None&lang=Default
  • POSTPOST /api/releaseEvents/{eventId}/reports/api/releaseEvents/:eventId/reports?reportType=InvalidInfo&notes=string&versionNumber=0
  • GETGET /api/releaseEvents/{id}/api/releaseEvents/:id?fields=None&lang=Default
  • DELETEDELETE /api/releaseEvents/{id}/api/releaseEvents/:id?notes=&hardDelete=false

ResourcesApi

  • GETGET /api/resources/{cultureCode}/api/resources/:cultureCode?setNames[]=string

SongListApi

  • POSTPOST /api/songLists/api/songLists
  • POSTPOST /api/songLists/comments/{commentId}/api/songLists/comments/:commentId
  • DELETEDELETE /api/songLists/comments/{commentId}/api/songLists/comments/:commentId
  • GETGET /api/songLists/featured/api/songLists/featured?query=&tagId[]=0&childTags=false&nameMatchMode=Auto&featuredCategory=Nothing&start=0&maxResults=10&getTotalCount=false&sort=None&fields=None&lang=Default
  • GETGET /api/songLists/featured/names/api/songLists/featured/names?query=&nameMatchMode=Auto&featuredCategory=Nothing&maxResults=10
  • DELETEDELETE /api/songLists/{id}/api/songLists/:id?notes=&hardDelete=false
  • GETGET /api/songLists/{listId}/comments/api/songLists/:listId/comments
  • POSTPOST /api/songLists/{listId}/comments/api/songLists/:listId/comments
  • GETGET /api/songLists/{listId}/songs/api/songLists/:listId/songs?query=&songTypes=string&pvServices=Nothing&tagId[]=0&artistId[]=0&childVoicebanks=false&advancedFilters={"filterType":"Nothing","negate":true,"param":"string"}&start=0&maxResults=10&getTotalCount=false&sort=None&nameMatchMode=Auto&fields=None&lang=Default

SongApi

  • GETGET /api/songs/api/songs?query=&songTypes=string&afterDate=2024-01-01T00:00:00Z&beforeDate=2024-01-01T00:00:00Z&tagName[]=string&tagId[]=0&childTags=false&unifyTypesAndTags=false&artistId[]=0&artistParticipationStatus=Everything&childVoicebanks=false&includeMembers=false&onlyWithPvs=false&pvServices=Nothing&since=0&minScore=0&userCollectionId=0&releaseEventId=0&parentSongId=0&status=Draft&advancedFilters={"filterType":"Nothing","negate":true,"param":"string"}&start=0&maxResults=10&getTotalCount=false&sort=None&preferAccurateMatches=false&nameMatchMode=Auto&fields=None&lang=Default&minMilliBpm=0&maxMilliBpm=0&minLength=0&maxLength=0
  • GETGET /api/songs/byPv/api/songs/byPv?pvService=NicoNicoDouga&pvId=string&fields=None&lang=Default
  • POSTPOST /api/songs/comments/{commentId}/api/songs/comments/:commentId
  • DELETEDELETE /api/songs/comments/{commentId}/api/songs/comments/:commentId
  • GETGET /api/songs/highlighted/api/songs/highlighted?languagePreference=Default&fields=None
  • GETGET /api/songs/lyrics/{lyricsId}/api/songs/lyrics/:lyricsId
  • GETGET /api/songs/names/api/songs/names?query=&nameMatchMode=Auto&maxResults=15
  • GETGET /api/songs/top-rated/api/songs/top-rated?durationHours=0&startDate=2024-01-01T00:00:00Z&filterBy=CreateDate&vocalist=Nothing&maxResults=25&fields=None&languagePreference=Default
  • GETGET /api/songs/{id}/api/songs/:id?fields=None&lang=Default
  • DELETEDELETE /api/songs/{id}/api/songs/:id?notes=
  • GETGET /api/songs/{id}/comments/api/songs/:id/comments
  • POSTPOST /api/songs/{id}/comments/api/songs/:id/comments
  • GETGET /api/songs/{id}/derived/api/songs/:id/derived?fields=None&lang=Default
  • GETGET /api/songs/{id}/ratings/api/songs/:id/ratings?userFields=None&lang=Default
  • POSTPOST /api/songs/{id}/ratings/api/songs/:id/ratings
  • GETGET /api/songs/{id}/related/api/songs/:id/related?fields=None&lang=Default

TagApi

  • GETGET /api/tags/api/tags?query=&allowChildren=true&categoryName=&start=0&maxResults=10&getTotalCount=false&nameMatchMode=Auto&sort=Nothing&preferAccurateMatches=false&fields=None&lang=Default&target=Nothing
  • POSTPOST /api/tags/api/tags?name=string
  • GETGET /api/tags/byName/{name}/api/tags/byName/:name?fields=None&lang=DefaultDeprecated.
  • GETGET /api/tags/categoryNames/api/tags/categoryNames?query=&nameMatchMode=Auto
  • POSTPOST /api/tags/comments/{commentId}/api/tags/comments/:commentId
  • DELETEDELETE /api/tags/comments/{commentId}/api/tags/comments/:commentId
  • GETGET /api/tags/names/api/tags/names?query=&allowAliases=true&maxResults=10
  • GETGET /api/tags/top/api/tags/top?categoryName=string&entryType=Undefined&maxResults=15&lang=Default
  • GETGET /api/tags/{id}/api/tags/:id?fields=None&lang=Default
  • DELETEDELETE /api/tags/{id}/api/tags/:id?notes=&hardDelete=false
  • GETGET /api/tags/{tagId}/children/api/tags/:tagId/children?fields=None&lang=Default
  • GETGET /api/tags/{tagId}/comments/api/tags/:tagId/comments
  • POSTPOST /api/tags/{tagId}/comments/api/tags/:tagId/comments
  • POSTPOST /api/tags/{tagId}/reports/api/tags/:tagId/reports?reportType=InvalidInfo&notes=string&versionNumber=0

UserApi

  • GETGET /api/users/api/users?query=&groups=Nothing&joinDateAfter=2024-01-01T00:00:00Z&joinDateBefore=2024-01-01T00:00:00Z&nameMatchMode=Auto&start=0&maxResults=10&getTotalCount=false&sort=RegisterDate&includeDisabled=false&onlyVerified=false&knowsLanguage=string&fields=None
  • GETGET /api/users/current/api/users/current?fields=None
  • GETGET /api/users/current/album-collection-statuses/{albumId}/api/users/current/album-collection-statuses/:albumId
  • POSTPOST /api/users/current/albums/{albumId}/api/users/current/albums/:albumId?collectionStatus=Nothing&mediaType=PhysicalDisc&rating=0
  • GETGET /api/users/current/followedArtists/{artistId}/api/users/current/followedArtists/:artistId
  • POSTPOST /api/users/current/followedTags/{tagId}/api/users/current/followedTags/:tagId
  • DELETEDELETE /api/users/current/followedTags/{tagId}/api/users/current/followedTags/:tagId
  • GETGET /api/users/current/ratedSongs/{songId}/api/users/current/ratedSongs/:songId
  • POSTPOST /api/users/current/refreshEntryEdit/api/users/current/refreshEntryEdit?entryType=Undefined&entryId=0
  • POSTPOST /api/users/current/songTags/{songId}/api/users/current/songTags/:songId
  • GETGET /api/users/messages/{messageId}/api/users/messages/:messageId
  • GETGET /api/users/names/api/users/names?query=&nameMatchMode=Auto&maxResults=10&includeDisabled=false
  • POSTPOST /api/users/profileComments/{commentId}/api/users/profileComments/:commentId
  • DELETEDELETE /api/users/profileComments/{commentId}/api/users/profileComments/:commentId
  • GETGET /api/users/{id}/api/users/:id?fields=None
  • GETGET /api/users/{id}/album-collection-statuses/{albumId}/api/users/:id/album-collection-statuses/:albumId
  • GETGET /api/users/{id}/albums/api/users/:id/albums?query=&tagId=0&tag=string&artistId=0&purchaseStatuses=Nothing&releaseEventId=0&albumTypes=Unknown&advancedFilters={"filterType":"Nothing","negate":true,"param":"string"}&start=0&maxResults=10&getTotalCount=false&sort=None&nameMatchMode=Auto&fields=None&lang=Default&mediaType=PhysicalDisc
  • GETGET /api/users/{id}/events/api/users/:id/events?relationshipType=Interested
  • GETGET /api/users/{id}/followedArtists/api/users/:id/followedArtists?query=&tagId[]=0&artistType=Unknown&start=0&maxResults=10&getTotalCount=false&sort=None&nameMatchMode=Auto&fields=None&lang=Default
  • GETGET /api/users/{id}/followedArtists/{artistId}/api/users/:id/followedArtists/:artistId
  • GETGET /api/users/{id}/messages/api/users/:id/messages?inbox=Nothing&unread=false&anotherUserId=0&start=0&maxResults=10&getTotalCount=false
  • POSTPOST /api/users/{id}/messages/api/users/:id/messages
  • DELETEDELETE /api/users/{id}/messages/api/users/:id/messages?messageId=0
  • GETGET /api/users/{id}/profileComments/api/users/:id/profileComments?start=0&maxResults=10&getTotalCount=false
  • POSTPOST /api/users/{id}/profileComments/api/users/:id/profileComments
  • GETGET /api/users/{id}/ratedSongs/api/users/:id/ratedSongs?query=&tagName=string&tagId[]=0&artistId[]=0&childVoicebanks=false&artistGrouping=And&rating=Nothing&songListId=0&groupByRating=true&pvServices=Nothing&advancedFilters={"filterType":"Nothing","negate":true,"param":"string"}&start=0&maxResults=10&getTotalCount=false&sort=None&nameMatchMode=Auto&fields=None&lang=Default
  • GETGET /api/users/{id}/ratedSongs/{songId}/api/users/:id/ratedSongs/:songId
  • POSTPOST /api/users/{id}/reports/api/users/:id/reports
  • POSTPOST /api/users/{id}/settings/{settingName}/api/users/:id/settings/:settingName
  • GETGET /api/users/{id}/songLists/api/users/:id/songLists?query=&tagId[]=0&childTags=false&nameMatchMode=Auto&start=0&maxResults=10&getTotalCount=false&sort=None&fields=None

VenueApi

  • GETGET /api/venues/api/venues?query=&fields=None&start=0&maxResults=10&getTotalCount=false&nameMatchMode=Auto&lang=Default&sortRule=None&latitude=0.0&longitude=0.0&radius=0.0&distanceUnit=Kilometers
  • DELETEDELETE /api/venues/{id}/api/venues/:id?notes=&hardDelete=false
  • POSTPOST /api/venues/{id}/reports/api/venues/:id/reports?reportType=InvalidInfo&notes=string&versionNumber=0

API details

Authentication
None declared in the description
Operations
129 operations on 98 pathsGET 76POST 33DELETE 20
2 marked deprecated
Main resources
UserApi 30AlbumApi 16SongApi 16TagApi 14DiscussionApi 11SongListApi 9ArtistApi 8ReleaseEventApi 7CommentApi 5ReleaseEventSeriesApi 4
Response formats
application/json text/json text/plain
Description format
OpenAPI 3.0.1, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the VocaDbWeb in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the VocaDbWeb collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “GET /api/activityEntries” (GET /api/activityEntries?before=2024-01-01T00:00:00Z&since=2024-01-01T00:00:00Z&userId=0&editEvent=Created&entryType=Undefined&maxResults=50&getTotalCount=false&fields=None&entryFields=None&lang=Default&sortRule=CreateDateDescending), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the VocaDbWeb?

VocaDbWeb endpoints from Vocadb It is listed under Media & content and has 129 endpoints.

Who publishes the VocaDbWeb?

It is listed from Vocadb's public API description (an OpenAPI document), not published by Vocadb on Swastik Codes. Anyone who controls vocadb.net can claim the profile by adding a DNS TXT record.

How do I authenticate with the VocaDbWeb?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the VocaDbWeb have?

129 operations on 98 paths (76 GET, 33 POST, 20 DELETE). The largest groups are UserApi, AlbumApi, SongApi, TagApi.

Is forking the VocaDbWeb free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.