Pular para o conteúdo
HILLS API v1 Acesso antecipado

Referência da API

Ganhos

Receita dos relatórios consolidados das plataformas por mês, lançamento ou plataforma, com a parte dos seus artistas.

Receita dos relatórios consolidados das plataformas por mês, lançamento ou plataforma, com a parte dos seus artistas.

URL base https://api.hillsmusic.com/v1. Toda requisição envia uma chave de API: Authorization: Bearer hm_live_….

  • Ganhos

Ganhos

GET /v1/earnings · Escopo: earnings:read

Receita dos relatórios consolidados das plataformas, em USD. amount_usd é o seu total; member_share_usd é a parte que os seus splits de receita destinam aos seus artistas e gravadoras.

Parâmetros

Parâmetro Em Tipo Obrigatório Descrição
by query month | release | store Não Como agrupar (padrão month).
months query integer (1–60) Não Quantos meses para trás (padrão 12).

Exemplo de requisição

curl "https://api.hillsmusic.com/v1/earnings?by=store&months=6" \
  -H "Authorization: Bearer $HILLS_API_KEY"

Resposta 200

{
  "by": "store",
  "months": 6,
  "currency": "USD",
  "data": [
    {
      "key": "Spotify",
      "label": "Spotify",
      "amount_usd": 1520.42,
      "member_share_usd": 1064.29,
      "units": 412003
    }
  ]
}

Erros

Status Quando
400 invalid: um parâmetro está errado; field indica qual.
401 unauthenticated, invalid_key, key_revoked, key_expired ou test_keys_retired.
403 insufficient_scope: falta à chave o escopo; scope indica qual. account_inactive ou api_not_in_plan.
429 rate_limited: aguarde Retry-After segundos.

Pronto para integrar?

Solicite acesso à API e retornamos em 1 a 3 dias úteis.