Pixela API Document

API Document for Pixela ( https://pixe.la/ ) .

GET - /v1/users/<username>/graphs/<graphID>/today

Description

This is an endpoint that responds with the Pixel of the day you requested this API.

The query parameter returnEmpty is available. See below for details.

HTTP Method , API endpoint

GET /v1/users/<username>/graphs/<graphID>/today

Query Parameter

Key Type Description
returnEmpty bool [optional] Specifying true for this param will return an empty Pixel instead of 404 Not Found if the Pixel is unregistered on the day of the request.

Possible errors by HTTP response status code

  • 404 Not Found
    • This error occurs when your request destination does not exist when it is not specfied returnEmpty param.
  • 500 Internal Server Error
    • Status in the event of an unexpected error. Retrying the request may be successfully processed.
  • 503 Service Unavailable
    • This error occurs when Pixela is temporarily unavailable. Please take a moment and retry your request.

Example

$ curl -X GET 'https://pixe.la/v1/users/a-know/graphs/test-graph/today?returnEmpty=true'
{"date":"20240414","quantity":"0"}