Endpoint Syntax and Format

Handling Spaces in Queries and Epoch Time in Responses

Handling Spaces in Queries

Request URLs must be URL-encoded. In practice this means that spaces in URL query values must be replaced with + and the @ symbol must be replaced with %40.

  • GOOD: ?search=New+York+City&start=1&limit=10

  • BAD: ?search=New York City&start=1&limit=10

HTTP will truncate the “”BAD”” query at the space after the word “New”, so you will receive 25 records (the default limit) matching only the word “New”.

Active Docs found on the Developer Portal will do the URL-encoding for you. In the Active Docs for Get Institutions, you would enter “”New York City”” in the field for the search parameter.

Handling Epoch Dates and Times

All dates and times RECEIVED FROM or SENT TO this API are given as Unix epoch timestamps. This is a long value representing the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • An epoch value is represented in seconds.

  • Timestamps in Java and Javascript are in milliseconds.

  • To convert from Java to epoch, divide the Java time by 1000.

  • To convert from epoch to Java, multiply the epoch time by 1000.

Epoch Converter has a page with a simple utility for converting quickly between readable dates and epoch timestamps.