Documentação: Busca em geral

Ne-Yo

Parâmetros da consulta
Resposta da consulta em JSON

Um dos recursos mais interessantes para buscar letras de músicas é a possibilidade de consultar por trecho. Muitas vezes o usuário não lembra do título da música, por isso, este segmento da API pode retornar as músicas que possúem tal trecho buscado.

Também temos buscas por Artistas, Músicas/Artistas e Álbuns para ajudar no seu desenvolvimento com a API do Vagalume.

IMPORTANTE: É importante dizer que o resultado da busca tem endereços do Vagalume que não podem ser omitidos. É obrigatório colocar os créditos do serviço para o Vagalume. Leia os termos de uso para mais informações.

Parâmetros da consulta

A consulta pode ser realizada via POST ou GET para obter a letra através do trecho digitado. Como nos exemplos a seguir:

https://api.vagalume.com.br/search.art?q=Skank&limit=5
https://api.vagalume.com.br/search.excerpt?q=vamos%20fugir&limit=5
https://api.vagalume.com.br/search.artmus?q=Skank%20Vamos%20Fugir&limit=5
https://api.vagalume.com.br/search.alb?q=U218%20Singles&limit=5

qvalor para consultar limitlimite sua busca especificando o valor neste parâmetro, sendo no máximo 10. Caso seja omitido, trará o limite padrão de 4 resultados.

Resposta da consulta em JSON

URL: https://api.vagalume.com.br/search.art?q=Skank&limit=5

	// Exemplo de retorno da requisição

	{
		"response":{
			"numFound": 2,
			"start": 0,
			"docs":[
				{
					"id": "b3ade68b3g8e86eda3",
					"url": "/skank/",
					"band": "Skank"
				},
				...
			]
		},
		"highlighting":{
			"l3ade68b7g3be34ea3":{
				"title":[
					"Skank"
				]
			},
		},
	...
	}

As propriedades do objeto JSON de resposta são as seguintes:

responseContém todas informações das músicas no Vagalume:

numFound Total de registros encontrados startInício da busca (campo inalterável) docs Listagem dos registros encontrados
idID do artista encontrada urlA URL do artista Vagalume bandNome da banda

highlightingInformações sobre trechos encontrados.

l3ade68b7g3be34ea3O 1º caractere "l" refere-se á palavra "letra" e o restante ao ID da música
band/bandaO nome da banda, será destacado por "...nome...".

URL: https://api.vagalume.com.br/search.excerpt?q=vamos%20fugir&limit=5

	// Exemplo de retorno da requisição

	{
		"response":{
			"numFound": 1114,
			"start": 0,
			"docs":[
				{
					"id": "l3ade68b7g3be34ea3",
					"url": "/skank/vamos-fugir.html",
					"title": "Vamos Fugir",
					"band": "Skank"
				},
				...
			]
		},
		"highlighting":{
			"l3ade68b7g3be34ea3":{
				"title":[
					"Vamos Fugir"
				]
			},
		},
	...
	}

As propriedades do objeto JSON de resposta são as seguintes:

responseContém todas informações das músicas no Vagalume:

numFound Total de registros encontrados startInício da busca (campo inalterável) docs Listagem dos registros encontrados
idID da música encontrada urlA URL da música no Vagalume titleO título da música encontrada bandNome da banda

highlightingInformações sobre trechos encontrados.

l3ade68b7g3be34ea3O 1º caractere "l" refere-se á palavra "letra" e o restante ao ID da música
title/letraO texto da letra ou titulo da música, será destacado por "...trecho...".

URL: https://api.vagalume.com.br/search.artmus?q=Skank%20Vamos%20Fugir&limit=5

	// Exemplo de retorno da requisição

	{
		"response":{
			"numFound": 1114,
			"start": 0,
			"docs":[
				{
					"id": "l3ade68b7g3be34ea3",
					"url": "/skank/vamos-fugir.html",
					"title": "Vamos Fugir",
					"band": "Skank"
				},
				...
			]
		},
		"highlighting":{
			"l3ade68b7g3be34ea3":{
				"title":[
					"Vamos Fugir"
				]
			},
		},
	...
	}

As propriedades do objeto JSON de resposta são as seguintes:

responseContém todas informações das músicas no Vagalume:

numFound Total de registros encontrados startInício da busca (campo inalterável) docs Listagem dos registros encontrados
idID da música encontrada urlA URL da música no Vagalume titleO título da música encontrada bandNome da banda

highlightingInformações sobre trechos encontrados.

l3ade68b7g3be34ea3O 1º caractere "l" refere-se á palavra "letra" e o restante ao ID da música
title/letraO texto da letra ou titulo da música, será destacado por "...trecho...".

URL: https://api.vagalume.com.br/search.alb?q=U218%20Singles&limit=5

	// Exemplo de retorno da requisição

	{
		"response":{
			"numFound": 68,
			"start": 0,
			"docs":[
				{
					"id": "l3ade68b7g3be34ea3",
					"url": "/u2/discografia/u218-singles.html",
					"title": "U218 Singles",
					"band": "U2"
				},
				...
			]
		},
		"highlighting":{
			"l3ade68b7g3be34ea3":{
				"title":[
					"U218 Singles"
				]
			},
		},
	...
	}

As propriedades do objeto JSON de resposta são as seguintes:

responseContém todas informações das músicas no Vagalume:

numFound Total de registros encontrados startInício da busca (campo inalterável) docs Listagem dos registros encontrados
idID do álbum urlA URL do álbum no Vagalume titleO título da música encontrada bandNome da banda

highlightingInformações sobre trechos encontrados.

l3ade68b7g3be34ea3O 1º caractere "l" refere-se á palavra "letra" e o restante ao ID da música
álbumO nome do álbum, será destacado por "...nome...".