bird 0.2.0

X API CLI with entity caching, search, threads, and watchlists
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://bird.dev/schema/usage-v1.json",
  "title": "bird usage payload",
  "description": "Shape of the data payload returned by `bird usage` under --output json. Reports API usage counts and cost estimates over a time window.",
  "type": "object",
  "properties": {
    "since": {
      "type": "string",
      "description": "Start date of the reporting window (YYYY-MM-DD)."
    },
    "until": {
      "type": "string",
      "description": "End date of the reporting window (YYYY-MM-DD)."
    },
    "requests": {
      "type": "integer",
      "description": "Total API requests issued in the window."
    },
    "tweets_read": {
      "type": "integer",
      "description": "Tweet objects consumed (counts toward read quota)."
    },
    "estimated_cost_usd": {
      "type": "number",
      "description": "Rough cost estimate using bird's local pricing table."
    },
    "by_command": {
      "type": "object",
      "description": "Per-subcommand breakdown keyed by command name.",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "requests": { "type": "integer" },
          "tweets": { "type": "integer" },
          "cost_usd": { "type": "number" }
        },
        "additionalProperties": true
      }
    },
    "source": {
      "type": "string",
      "description": "Where the numbers came from (\"local\" for offline cache estimate, \"api\" for upstream metering).",
      "enum": ["local", "api", "mixed"]
    }
  },
  "additionalProperties": true
}