シャロシコAPI

[GET] /api/v1/count.json

パラメーター

(GETクエリとかガン無視っすよね？)

(bool) url

URL(syaroshi.co)をカウント対象に入れるか否か true/false

(bool) shico

「シャロシコ」(単語) を検索対象に入れるか否か true/false

(bool) force_cache

強制的にキャッシュを使用する true/false

(bool) chino

シャロシコの代わりにチノシコをカウントする。他のオプションとは併用不可。オプションをつけると値に関わらず有効。

レスポンス

count

見つかったツイート数

max_id

検索に含めた最新のツイートのID

query

検索ワード

queried

full/diff/cached

timestamp

Cached Time

Example

req

GET https://api.syaroshico.hinaloe.net/api/v1/count.json

res

{"count":1310,"max_id":"673558909290856449","query":"syaroshi.co OR \u30b7\u30e3\u30ed\u30b7\u30b3 exclude:retweets","queried":"cache","timestamp":"1449434847"}

res (expanded)

{
  "count": 1310,
  "max_id": "673558909290856449",
  "query": "syaroshi.co OR シャロシコ exclude:retweets",
  "queried": "cache",
  "timestamp": "1449434847"
}

カウントは2分間のキャッシュを取っています。キャッシュを使用しない場合、Twitter APIにリクエストを送るためレスポンスに多少のタイムロスが生じます。

このAPIには現在レートリミット等の制限は設けていませんが、TwitterのAPIやこのプログラムの内部的エラーが返される場合があります。

エラーの際はmessageにエラーメッセージ、errorにtrueを含むJSONが返されます。countにカウントが含まれる場合もありますが、負の値が含まれる可能性があることを考慮してください。(この場合カウントとは関係が無くなります)

CORSに対応しています。JavaScript+XHR2で任意のサイトにカウントを利用できます。但し現在JSONPのサポートの予定はありません。必要な場合は検討するので問い合わせてください。

全てのエンドポイントへのアクセスはSSL(TLS)によって保護されます。もし証明書にエラーがある際は@hnle0にpingしてください。

ソースコードはGitHubにてMITライセンスにて公開しています。

Fork me on GitHub

桐間紗路,@sudosan