Hacker Zone
tools made for hackerspaces

It's highly recommended to use the explicit specified fields from the reference. If you need other fields additionally, please make a change request. Or prefix custom fields with ext_ to make it clear the field is not part of the documented API. Consumers are not obligated to interpret any custom fields

Description
The version of SpaceAPI your endpoint uses
Allowed values
0.11
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The name of your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The main website
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The postal address of your space (street, block, housenumber, zip code, city, whatever you usually need in your country, and the country itself)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Longitude of your space location, in degree with decimal places. Use positive values for locations west of Greenwich, and negative values for locations east of Greenwich.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL(s) of webcams in your space
Data type of array elements
string
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A mapping of stream types to stream URLs. Example: {'mp4':'http//example.org/stream.mpg', 'mjpeg':'http://example.org/stream.mjpeg'}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A boolean which indicates if the space is currently open
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An additional free-form string, could be something like 'open for public', 'members only' or whatever you want it to be
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The Unix timestamp when the space status changed most recently
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'
Data type of array elements
object
Nested elements
Description
Name or other identity of the subject (e.g. J. Random Hacker, fridge, 3D printer, …)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Action (e.g. check-in, check-out, finish-print, …). Define your own actions and use them consistently, canonical actions are not (yet) specified
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Unix timestamp when the event occured
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A custom text field to give more information about the event
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Contact information about your space
Nested elements
Description
Phone number, including country code with a leading plus sign. Example: +1 800 555 4567
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URI for Voice-over-IP via SIP. Example: sip:yourspace@sip.example.org
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Phone numbers of people who carry a key and are able to open the space upon request. Example: ['+1 800 555 4567','+1 800 555 4544']
Data type of array elements
string
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL of the IRC channel, in the form irc://example.org/#channelname
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Twitter handle, with leading @
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
E-mail address for contacting your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The e-mail address of your mailing list. If you use Google Groups then the e-mail looks like your-group@googlegroups.com.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A public Jabber/XMPP multi-user chatroom in the form chatroom@conference.example.net
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Icons that show the status graphically
Nested elements
Description
The URL to your customized space logo showing an open space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The URL to your customized space logo showing a closed space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The version of SpaceAPI your endpoint uses
Allowed values
0.12
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The name of your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The main website
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The postal address of your space (street, block, housenumber, zip code, city, whatever you usually need in your country, and the country itself)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Longitude of your space location, in degree with decimal places. Use positive values for locations west of Greenwich, and negative values for locations east of Greenwich.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL(s) of webcams in your space
Data type of array elements
string
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A mapping of stream types to stream URLs. Example: {'mp4':'http//example.org/stream.mpg', 'mjpeg':'http://example.org/stream.mjpeg'}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A boolean which indicates if the space is currently open
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An additional free-form string, could be something like 'open for public', 'members only' or whatever you want it to be
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The Unix timestamp when the space status changed most recently
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'
Data type of array elements
object
Nested elements
Description
Name or other identity of the subject (e.g. J. Random Hacker, fridge, 3D printer, …)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Action (e.g. check-in, check-out, finish-print, …). Define your own actions and use them consistently, canonical actions are not (yet) specified
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Unix timestamp when the event occured
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A custom text field to give more information about the event
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Contact information about your space
Nested elements
Description
Phone number, including country code with a leading plus sign. Example: +1 800 555 4567
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URI for Voice-over-IP via SIP. Example: sip:yourspace@sip.example.org
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Phone numbers of people who carry a key and are able to open the space upon request. Example: ['+1 800 555 4567','+1 800 555 4544']
Data type of array elements
string
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL of the IRC channel, in the form irc://example.org/#channelname
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Twitter handle, with leading @
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
E-mail address for contacting your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The e-mail address of your mailing list. If you use Google Groups then the e-mail looks like your-group@googlegroups.com.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A public Jabber/XMPP multi-user chatroom in the form chatroom@conference.example.net
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Icons that show the status graphically
Nested elements
Description
The URL to your customized space logo showing an open space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The URL to your customized space logo showing a closed space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Data of various sensors in your space (e.g. temperature, humidity, amount of Club-Mate left, …). The only canonical property is the temp property, additional sensor types may be defined by you. In this case, you are requested to share your definition for inclusion in this specification.
Data type of array elements
object
Nested elements
Description
A mapping of measuring locations to temperature values. The values should match the basic regular expression ^[+-]?[0-9]+(\.[0-9]+)?[FCK]$. Example: {'kitchen':'48F', 'storage':'-273.1K'}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feeds where users can get updates of your space
Data type of array elements
object
Nested elements
Description
A mnemonic identifier, like wiki, blog, etc.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Type of the feed, for example rss, atom, ical
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feed URL
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The version of SpaceAPI your endpoint uses
Allowed values
0.13
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The name of your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL to your space website
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Position data such as a postal address or geographic coordinates
Nested elements
Description
The postal address of your space (street, block, housenumber, zip code, city, whatever you usually need in your country, and the country itself).
Examples:
  • Netzladen e.V., Breite Straße 74, 53111 Bonn, Germany
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Longitude of your space location, in degree with decimal places. Use positive values for locations west of Greenwich, and negative values for locations east of Greenwich.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A flag indicating if the hackerspace uses SpaceFED, a federated login scheme so that visiting hackers can use the space WiFi with their home space credentials.
Nested elements
Description
See the wiki.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
See the wiki.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
See the wiki.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL(s) of webcams in your space
Data type of array elements
string
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A mapping of stream types to stream URLs.If you use other stream types make a change request or prefix yours with ext_ .
Nested elements
Description
Your mpg stream URL. Example: {"mp4": "http//example.org/stream.mpg"}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Your mjpeg stream URL. Example: {"mjpeg": "http://example.org/stream.mjpeg"}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Your ustream stream URL. Example: {"ustream": "http://www.ustream.tv/channel/hackspsps"}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A collection of status-related data: actual open/closed status, icons, last change timestamp etc.
Nested elements
Description
A flag which indicates if the space is currently open or closed. The state 'undefined' can be achieved by assigning this field the value 'null' (without the quotes). In most (all?) programming languages this is evaluated to false so that no app should break
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The Unix timestamp when the space status changed most recently
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The person who lastly changed the state e.g. opened or closed the space.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An additional free-form string, could be something like 'open for public', 'members only' or whatever you want it to be
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Icons that show the status graphically
Nested elements
Description
The URL to your customized space logo showing an open space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The URL to your customized space logo showing a closed space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'
Data type of array elements
object
Nested elements
Description
Name or other identity of the subject (e.g. J. Random Hacker, fridge, 3D printer, …)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Action (e.g. check-in, check-out, finish-print, …). Define your own actions and use them consistently, canonical actions are not (yet) specified
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Unix timestamp when the event occured
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A custom text field to give more information about the event
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Contact information about your space. You must define at least one which is in the list of allowed values of the issue_report_channels field.
Nested elements
Description
Phone number, including country code with a leading plus sign. Example: +1 800 555 4567
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URI for Voice-over-IP via SIP. Example: sip:yourspace@sip.example.org
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Persons who carry a key and are able to open the space upon request. One of the fields irc_nick, phone, email or twitter must be specified.
Data type of array elements
object
Minimum amount
1
Nested elements
Description
Real name
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Contact the person with this nickname directly in irc if available. The irc channel to be used is defined in the contact/irc field.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Example: ['+1 800 555 4567','+1 800 555 4544']
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Email address which can be base64 encoded.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Twitter username with leading @.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL of the IRC channel, in the form irc://example.org/#channelname
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Twitter handle, with leading @
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Facebook account.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Google services.
Nested elements
Description
Google plus.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Identi.ca or StatusNet account, in the form yourspace@example.org
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Foursquare ID, in the form 4d8a9114d85f3704eab301dc.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
E-mail address for contacting your space. If this is a mailing list consider to use the contact/ml field.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The e-mail address of your mailing list. If you use Google Groups then the e-mail looks like your-group@googlegroups.com.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A public Jabber/XMPP multi-user chatroom in the form chatroom@conference.example.net
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A seperate email address for issue reports (see the issue_report_channels field). This value can be Base64-encoded.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This array defines all communication channels where you want to get automated issue reports about your SpaceAPI endpoint from the revalidator. This field is meant for internal usage only and it should never be consumed by any app. At least one channel must be defined. Please consider that when using ml the mailing list moderator has to moderate incoming emails or add the sender email to the subscribers. If you don't break your SpaceAPI implementation you won't get any notifications ;-)
Data type of array elements
string
Allowed values
email, issue_mail, twitter, ml
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Data of various sensors in your space (e.g. temperature, humidity, amount of Club-Mate left, …). The only canonical property is the temp property, additional sensor types may be defined by you. In this case, you are requested to share your definition for inclusion in this specification.
Nested elements
Description
Temperature sensor. To convert from one unit of temperature to another consider Wikipedia.
Data type of array elements
object
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value.
Allowed values
°C, °F, K, °De, °N, °R, °Ré, °Rø
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Sensor type to indicate if a certain door is locked.
Data type of array elements
object
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as front door, chill room or lab.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Barometer sensor
Data type of array elements
object
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
hPA
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Compound radiation sensor. Check this resource.
Nested elements
Description
An alpha sensor
Data type of array elements
object
Nested elements
Description
Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula:
cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )
Conversion formula:
µSv/h = cpm x conversion_factor
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Choose the appropriate unit for your radiation sensor instance.
Allowed values
cpm, r/h, µSv/h, mSv/a, µSv/a
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The dead time in µs. See the description of the value field to see how to use the dead time.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The conversion from the cpm unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. Note: only trust your manufacturer if it comes to the actual factor value. The internet seems full of wrong copy & pastes, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A beta sensor
Data type of array elements
object
Nested elements
Description
Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula:
cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )
Conversion formula:
µSv/h = cpm x conversion_factor
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Choose the appropriate unit for your radiation sensor instance.
Allowed values
cpm, r/h, µSv/h, mSv/a, µSv/a
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The dead time in µs. See the description of the value field to see how to use the dead time.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The conversion from the cpm unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. Note: only trust your manufacturer if it comes to the actual factor value. The internet seems full of wrong copy & pastes, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A gamma sensor
Data type of array elements
object
Nested elements
Description
Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula:
cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )
Conversion formula:
µSv/h = cpm x conversion_factor
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Choose the appropriate unit for your radiation sensor instance.
Allowed values
cpm, r/h, µSv/h, mSv/a, µSv/a
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The dead time in µs. See the description of the value field to see how to use the dead time.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The conversion from the cpm unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. Note: only trust your manufacturer if it comes to the actual factor value. The internet seems full of wrong copy & pastes, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A sensor which cannot filter beta and gamma radiation seperately.
Data type of array elements
object
Nested elements
Description
Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula:
cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )
Conversion formula:
µSv/h = cpm x conversion_factor
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Choose the appropriate unit for your radiation sensor instance.
Allowed values
cpm, r/h, µSv/h, mSv/a, µSv/a
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The dead time in µs. See the description of the value field to see how to use the dead time.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The conversion from the cpm unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. Note: only trust your manufacturer if it comes to the actual factor value. The internet seems full of wrong copy & pastes, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Humidity sensor
Data type of array elements
object
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
%
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
How much Mate and beer is in your fridge?
Data type of array elements
object
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit, either btl for bottles or crt for crates.
Allowed values
btl, crt
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Room 1 or Room 2 or Room 3, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The power consumption of a specific device or of your whole space.
Data type of array elements
object
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
mW, W, VA
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Your wind sensor.
Data type of array elements
object
Nested elements
Nested elements
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
m/s, km/h, kn
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
m/s, km/h, kn
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The wind direction in degrees. Use this mapping to convert the degrees into a string.
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
°
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Height above mean sea level.
Nested elements
Description
The sensor value
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.
Allowed values
m
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This sensor type is to specify the currently active ethernet or wireless network devices. You can create different instances for each network type.
Data type of array elements
object
Nested elements
Description
This field is optional but you can use it to the network type such as wifi or cable. You can even expose the number of spacenet-authenticated connections.
Allowed values
wifi, cable, spacenet
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The amount of network connections.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The machines that are currently connected with the network.
Data type of array elements
object
Nested elements
Description
The machine name.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The machine's MAC address of the format D3:3A:DB:EE:FF:00.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The location of your sensor such as Outside, Inside, Ceiling, Roof or Room 1.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
How rich is your hackerspace?
Data type of array elements
object
Nested elements
Description
How much?
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
What's the currency? If your currency is missing open a new issue and request the addition of your currency according ISO 4217.
Allowed values
BTC, EUR, USD, GBP
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
If you have more than one account you can use this field to specify where it is.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Give your sensor instance a name.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Specify the number of space members.
Data type of array elements
object
Nested elements
Description
The amount of your space members.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Specify the location if your hackerspace has different departments (for whatever reason). This field is for one department. Every department should have its own sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
You can use this field to specify if this sensor instance counts active or inactive members.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Specify the number of people that are currently in your space. Optionally you can define a list of names.
Data type of array elements
object
Nested elements
Description
The amount of present people.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
If you use multiple sensor instances for different rooms, use this field to indicate the location.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Give this sensor a name if necessary at all. Use the location field for the rooms. This field is not intended to be used for names of hackerspace members. Use the field 'names' instead.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
List of hackerspace members that are currently occupying the space.
Data type of array elements
string
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An extra field that you can use to attach some additional information to this sensor instance.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feeds where users can get updates of your space
Nested elements
Nested elements
Description
Type of the feed, for example rss, atom, ical
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feed URL
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Nested elements
Description
Type of the feed, for example rss, atom, ical
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feed URL
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Nested elements
Description
Type of the feed, for example rss, atom, ical
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feed URL
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Nested elements
Description
Type of the feed, for example rss, atom, ical
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Feed URL
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Specifies options about caching of your SpaceAPI endpoint. Use this if you want to avoid hundreds/thousands of application instances crawling your status.
Nested elements
Description
Cache update cycle. This field must match the basic regular expression ^[mhd]\.[0-9]{2}$, where the first field specifies a unit of time (m for 1 minute, h for 1 hour, d for 1 day), and the second field specifies how many of this unit should be skipped between updates. For example, m.10 means one updates every 10 minutes, h.03 means one update every 3 hours, and d.01 means one update every day.
Allowed values
m.02, m.05, m.10, m.15, m.30, h.01, h.02, h.04, h.08, h.12, d.01
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Your project sites (links to GitHub, wikis or wherever your projects are hosted)
Data type of array elements
string
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A list of radio shows that your hackerspace might broadcast.
Data type of array elements
object
Nested elements
Description
The name of the radio show.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The stream URL which must end in a filename or a semicolon such as
  • http://signal.hackerspaces.org:8090/signal.mp3
  • http://85.214.64.213:8060/;
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The stream encoder.
Allowed values
mp3, ogg
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Specify the start time by using the ISO 8601 standard. This encodes the time as follows:

  • Combined date and time in UTC: 2013-06-10T10:00Z
  • Combined date and time in localtime with the timezone offset: 2013-06-10T12:00+02:00
  • Combined date and time in localtime with the timezone offset: 2013-06-10T07:00-03:00
The examples refer all to the same time.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Specify the end time by using the ISO 8601 standard. This encodes the time as follows:

  • Combined date and time in UTC: 2013-06-10T10:00Z
  • Combined date and time in localtime with the timezone offset: 2013-06-10T12:00+02:00
  • Combined date and time in localtime with the timezone offset: 2013-06-10T07:00-03:00
The examples refer all to the same time.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The version of SpaceAPI your endpoint uses
Allowed values
0.8
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The name of your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The main website
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Phone number, including country code with a leading plus sign. Example: +1 800 555 4567
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL(s) of webcams in your space
Data type of array elements
string
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A mapping of stream types to stream URLs. Example: {'mp4':'http//example.org/stream.mpg', 'mjpeg':'http://example.org/stream.mjpeg'}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A boolean which indicates if the space is currently open
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An additional free-form string, could be something like 'open for public', 'members only' or whatever you want it to be
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The Unix timestamp when the space status changed most recently
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'
Data type of array elements
object
Nested elements
Description
Name or other identity of the subject (e.g. J. Random Hacker, fridge, 3D printer, …)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Action (e.g. check-in, check-out, finish-print, …). Define your own actions and use them consistently, canonical actions are not (yet) specified
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Unix timestamp when the event occured
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A custom text field to give more information about the event
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The version of SpaceAPI your endpoint uses
Allowed values
0.9
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The name of your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The main website
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The postal address of your space (street, block, housenumber, zip code, city, whatever you usually need in your country, and the country itself)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Longitude of your space location, in degree with decimal places. Use positive values for locations west of Greenwich, and negative values for locations east of Greenwich.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL(s) of webcams in your space
Data type of array elements
string
Minimum amount
1
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A mapping of stream types to stream URLs. Example: {'mp4':'http//example.org/stream.mpg', 'mjpeg':'http://example.org/stream.mjpeg'}
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A boolean which indicates if the space is currently open
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
An additional free-form string, could be something like 'open for public', 'members only' or whatever you want it to be
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The Unix timestamp when the space status changed most recently
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'
Data type of array elements
object
Nested elements
Description
Name or other identity of the subject (e.g. J. Random Hacker, fridge, 3D printer, …)
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Action (e.g. check-in, check-out, finish-print, …). Define your own actions and use them consistently, canonical actions are not (yet) specified
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Unix timestamp when the event occured
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A custom text field to give more information about the event
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Contact information about your space
Nested elements
Description
Phone number, including country code with a leading plus sign. Example: +1 800 555 4567
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URI for Voice-over-IP via SIP. Example: sip:yourspace@sip.example.org
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Phone numbers of people who carry a key and are able to open the space upon request. Example: ['+1 800 555 4567','+1 800 555 4544']
Data type of array elements
string
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
URL of the IRC channel, in the form irc://example.org/#channelname
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
Twitter handle, with leading @
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
E-mail address for contacting your space
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
The e-mail address of your mailing list. If you use Google Groups then the e-mail looks like your-group@googlegroups.com.
Nested elements
%PROPERTY_NESTED_ELEMENTS%
Description
A public Jabber/XMPP multi-user chatroom in the form chatroom@conference.example.net
Nested elements
%PROPERTY_NESTED_ELEMENTS%
{
    "api": "0.13",
    "space": "Slopspace",
    "logo": "http://your-space.org/img/logo.png",
    "url": "http://your-space.org",
    "location": {
        "address": "Ulmer Strasse 255, 70327 Stuttgart, Germany",
        "lon": 9.236,
        "lat": 48.777
    },
    "contact": {
        "twitter": "@spaceapi"
    },
    "issue_report_channels": [
        "twitter"
    ],
    "state": {
        "open": true
    }
}
{
    /* put here all the fields from the minimal example */
    ...
    "projects": [
        "http://github.com/spaceapi",
        "http://wiki.example.com"
    ],
    "cache": {
        "schedule": "m.02"
    }
}
{
    /* put here all the fields from the minimal example */
    ...
    "feeds": {
        "blog": {
            "type": "application/rss+xml",
            "url": "https://example.com/feed/"
        },
        "calendar": {
            "type": "text/calendar",
            "url": "https://example.com/events.ics"
        }
    }
}
{
    /* put here all the fields from the minimal example */
    ...
    "radio_show": [
        {
            "name": "Signal",
            "url": "http://signal.hackerspaces.org:8090/signal.mp3",
            "type": "mp3",
            "start": "2013-06-10T12:00+02:00",
            "end": "2013-06-10T13:00+02:00"
        },
        {
            "name": "Random",
            "url": "http://85.214.64.213:8060/;",
            "type": "mp3",
            "start": "2013-06-13T09:00+02:00",
            "end": "2013-06-13T12:00+02:00"
        }
    ]
}
{
    /* put here all the fields from the minimal example */
    ...
    "sensors" : {
        "temperature": [
            {
                "value" : 3,
                "unit" : "°C",
                "location" : "Outside",
                "name" : "Roof"
            },
            {
                "value" : 3,
                "unit" : "°C",
                "location" : "Room 1",
                "name" : "Corner 1"
            },
            {
                "value" : 3,
                "unit" : "°C",
                "location" : "Room 1",
                "name" : "Corner 2"
            }
        ],
        "ext_spiff_diff" : [ /* unofficial extension */
            {
                "value" : 32,
                "unit" : "spdf",
                "location" : "locker1",
                "name" : "asdf"
            }
        ]
    }
}

The directory aggregates hackerspaces that provide an endpoint of their Space API implementation. The directory can then be loaded by web apps to do cool things such as rendering a map.

As not every app needs every endpoint because some endpoints don't provide the fields that they're interested in, the endpoints can be filtered by appending ?filter=<filter_key> or ?api=<operator><api_version>.

Filter by API

Endpoints can also be filtered by their version with the api argument. However this cannot be used with filter together:

Filter by implemented keys

Example:One filter
Scenario:Get all the endpoints which include the contact field.
Expression:contact
Link:directory.json?filter=contact
Example:Disjunction
Scenario:Get all the endpoints which include the contact or feeds field.
Expression:or( contact , feeds )
Link:directory.json?filter=or(contact,feeds)
Example:Conjunction
Scenario:Get all the endpoints which include the contact.irc and contact.phone field.
Expression:and( contact.irc , contact.phone )
Link:directory.json?filter=and(contact.irc,contact.phone)
Example:Mixed
Scenario:Get all the endpoints which have implemented contact and feeds and either sensors or stream.
Expression:and( contact , feeds , or( sensors , stream ) )
Link:directory.json?filter=and(contact,feeds,or(sensors,stream))

Filters - Overview


Filters - Sensors