chronoskin

for developers

The API today

All methods answering. Last trouble: 19 days ago.

Signed in

maren_holt, 2 keys

Build on your notebooks

Everything chronoskin does in the browser, your own program can do with one web address and a key.

Get a key Read the reference

Ask for the newest notes

GET /v2/notes?book=harbour&key=YOUR_KEY

200 OK
{ "notes": [
  { "id": 412, "title": "Ferry times" },
  { "id": 409, "title": "Tide table" } ] }
  • 1.2 millioncalls answered yesterday
  • 840programs with a key ?A program counts once it has made a call with its key.
  • 0.09 sfor a usual answer

Ruby

Every method in one small file. Version 0.4.

Get the library

PHP

One class, no extensions needed. Version 1.1.

Get the library

Python

Reads and writes notes in three lines. Version 0.9.

Get the library

JavaScript

For pages that show a notebook. Version 0.2.

Get the script

  1. 12Oct

    Version 2 of the notes API is open to everyone NEW

    by Ines Varga, 14 comments

    After six weeks behind a sign-up list, version 2 is switched on for every key. Answers come back as JSON by default, paging works the same way on every list, and the old XML replies stay for a year.

    releaseapiRead on »

  2. 3Oct

    Paging through long lists without losing your place

    by Tobias Renn, 6 comments

    Page numbers break when a notebook changes while you read it. The new after marker does not: ask for the notes after the last one you saw.

    howtopagingRead on »

  3. 21Sep

    What we learned from a million calls a day

    by Maren Holt, 22 comments

    Most calls ask for the same forty notebooks. We now keep those answers ready, and nine calls in ten come back in under a tenth of a second.

    serversnumbersRead on »

  4. 9Sep

    A Ruby library, written by one of you

    by Ines Varga, 3 comments

    Oskar Lind wrapped every method in forty lines of Ruby and sent it in. It is now the library we point to.

    librariesthanksRead on »

New here?

A key is free and takes a minute. The first call usually works within five.

Get a key First steps
  1. Developers
  2. /
  3. Blog
  4. /
  5. Version 2 is open to everyone

Version 2 of the notes API is open to everyone

Posted on 12 October by Ines Varga, filed under release api

See the reference

What changes today

After six weeks behind a sign-up list, version 2 is switched on for every key. Nothing you have written stops working: version 1 keeps answering for a year, at its old address.

Answers in JSON

Every method now answers in JSON unless you ask otherwise. Add format=xml to a call and you get the reply you are used to. The names of the fields are the same in both.

Three things to check in your program

  • Calls go to /v2/ instead of /v1/.
  • Lists come twenty to a page, not fifty.
  • A missing note answers 404, no longer an empty list.

The full list of methods, with their limits, is in the reference.

The same call, old and new

before  GET /v1/notes.xml?book=harbour
now     GET /v2/notes?book=harbour

Still on version 1?

It answers until next October. Your keys work for both.

Check your keys

Four of 14 comments

  1. 12Oct

    Oskar Lind wrote at 10:42

    Moved the Ruby library over in ten minutes. The 404 for a missing note is what I wanted all along.

  2. 12Oct

    quietharbour wrote at 13:05

    Does the limit of 120 calls a minute count per key or per program?

  3. 13Oct

    Ines Varga wrote at 9:20 Staff

    Per key. The reference says so now; thank you for asking.

  4. 13Oct

    Annika Dorn wrote at 16:48

    Paging by marker fixed a bug we had chased for a month.

Show all 14 comments

Write a comment

Not posted yet. The mail address below does not look complete.

First comment here? It is read by one of us before it appears, usually within the hour.

Add the ending, such as .example.

Plain text. Lines that start with four spaces are shown as code.

Next time
  1. Developers
  2. /
  3. API reference
  4. /
  5. Notes

API reference: notes

Every method that reads or writes a note, with the address to call and how often you may.

Get a key
Method What it does Status Calls a minute
notes.list
GET /v2/notes		 The notes of one notebook, newest first, twenty to a page. Stable 120
notes.get
GET /v2/notes/412		 One note with its text, labels and the people who can read it. Stable 120
notes.add
POST /v2/notes		 Adds a note to a notebook. Needs a key that may write. Stable 30
notes.remove
DELETE /v2/notes/412		 Moves a note to the bin, where it stays for thirty days. Stable 30
search.find
GET /v2/search		 Notes that contain every word of the query. Beta 20
export.all
GET /v1/export		 Every note as one XML file. Use notes.list with paging instead. Going away 2

Stable will not change within version 2 Beta may still change Going away switched off next October NEW added this month Staff 6 methods api

Making a call

Every call is a plain web address with your key on the end. Lists take page or after; everything else is named in the table above.

notes.get

GET /v2/notes/412?key=YOUR_KEY

200 OK
{ "id": 412, "title": "Ferry times",
  "labels": ["harbour", "travel"],
  "changed": "2008-10-12T09:20:00Z" }

Get a key What changed in version 2 Libraries Back to the blog

  1. Developers
  2. /
  3. maren_holt
  4. /
  5. Keys

Your keys

One key for each program that calls the API. A key can read, or read and write.

Keys and limits
Program May Status Calls today
Ferry timetable page
7f3a...c2e1		 read In use 4,812
Notebook by mail
b90d...41aa		 read and write Near its limit 27,440
Old desktop tool
02c7...9be4		 read Revoked 0
Test script
e1d4...7703		 read and write In use 36

Your limits

120 calls a minute and 30,000 a day for each key. One key is close to the daily limit.

Notebook by mail91%

27,440 of 30,000

Ferry timetable page16%

4,812 of 30,000
How limits work

Programs you have listed for others

Nothing listed yet

Tell other people what you built and it appears beside the blog.

List a program