{{.Desc}}
API base URL:
/api
Formats available:
/api/plain
Endpoints:
/api/plain/users
/api/plain/mentions
/api/plain/tweets
/api/plain/tags
All queries accept ?page=N
as a parameter, returning sets of 20 results.
This may be omitted for the first page of results.
Query by user:
$ curl '{{.URL}}/api/plain/users?q=foo'
foo https://example.com/twtxt.txt 2019-05-09T08:42:23.000Z
foobar https://example2.com/twtxt.txt 2019-03-14T19:23:00.000Z
foo_barrington https://example3.com/twtxt.txt 2019-05-01T15:59:39.000Z
Query by tweet content:
$ curl '{{.URL}}/api/plain/tweets?q=getwtxt&page=2'
foo_barrington https://example3.com/twtxt.txt 2019-04-30T06:00:09.000Z I just built getwtxt, time to set it up!
Query by mention:
$ curl '{{.URL}}/api/plain/mentions?url=https://foobarrington.co.uk/twtxt.txt'
foo https://example.com/twtxt.txt 2019-02-26T11:06:44.000Z @<foo_barrington https://example3.com/twtxt.txt> Hey!! Are you still working on that project?
Query by tag:
$ curl '{{.URL}}/api/plain/tags/programming'
foo https://example.com/twtxt.txt 2019-03-01T09:31:02.000Z I love #programming!
Get 20 tweets:
$ curl '{{.URL}}/api/plain/tweets?page=2'
foobar https://example2.com/twtxt.txt 2019-05-13T12:46:20.000Z It's been a busy day at work!
...
Get all users:
$ curl '{{.URL}}/api/plain/users'
foo_barrington https://example3.com/twtxt.txt 2018-11-21T18:31:00.000Z
...
Add new user by submitting a POST
request. If both variables are not used, or the user already exists in this registry, the server will respond with 400 Bad Request
$ curl -X POST '{{.URL}}/api/plain/users?url=https://example3.com/twtxt.txt&nickname=foo_barrington'
200 OK