Ler dados (GET)
As requisições GET retornam as linhas da planilha em JSON. A primeira linha da planilha fornece os nomes das colunas usados na resposta.
Ler todas as linhas
- cURL
- JavaScript
- Python
curl 'https://api.sheetbest.com/sheets/<api-id>'
fetch('https://api.sheetbest.com/sheets/<api-id>')
.then((r) => r.json())
.then(console.log);
import requests
requests.get('https://api.sheetbest.com/sheets/<api-id>').json()
Resposta:
[
{ "Id": "1", "Name": "John Doe", "Age": "23" },
{ "Id": "2", "Name": "Jane Doe", "Age": "34" }
]
Ler uma única linha
Acrescente o índice da linha à URL. Os índices começam em zero, então /2 retorna a terceira linha de dados.
- cURL
- JavaScript
- Python
curl 'https://api.sheetbest.com/sheets/<api-id>/2'
fetch('https://api.sheetbest.com/sheets/<api-id>/2');
requests.get('https://api.sheetbest.com/sheets/<api-id>/2')
Ler um intervalo de linhas
Use a notação abreviada <start>:<end> para ler um intervalo contínuo. Ela equivale a passar _limit e _offset:
# Rows 2 and 3
curl 'https://api.sheetbest.com/sheets/<api-id>/2:4'
# Same request, expanded
curl 'https://api.sheetbest.com/sheets/<api-id>?_limit=2&_offset=2'
Veja Paginação para saber mais.
Valores processados e valores originais
Por padrão, todos os valores são retornados como strings processadas. Adicione ?_raw=1 para receber os tipos nativos (números, booleanos, datas) como o Google Sheets os armazena:
curl 'https://api.sheetbest.com/sheets/<api-id>?_raw=1'
Para outras estruturas de resposta (records, dict, list, series, split, index), veja Formatos de dados.
Ler uma aba específica
A primeira aba é usada por padrão. Para ler outra, acrescente /tabs/<TabName>:
curl 'https://api.sheetbest.com/sheets/<api-id>/tabs/Admin'
Veja Trabalhar com abas.
Filtros e consultas
Você pode filtrar linhas pelo valor de uma coluna (/<Column>/<Value>, com curingas * opcionais) ou usar operadores de comparação com /query. Eles são documentados separadamente:
- Filtrar dados: correspondências exatas e filtros com curingas.
- Consultas avançadas: operadores
__eq,__ne,__lt,__lte,__gt,__gte.
Cabeçalhos de resposta
Cada resposta inclui cabeçalhos que descrevem sua planilha e o uso da cota, como X-Sheet-Rows, X-Sheet-Columns e a série X-RateLimit-*. Veja Cabeçalhos de resposta.