Stand up example APIs

[gbinal]

Summary:

• https://autoapi.18f.gov/
• https://autoapi2.18f.gov/

To access the API as JSON, use a JSON viewer such as POSTMAN for Chrome

SEC Example 1:

• source file - source page
• https://autoapi.18f.gov/q3_2014_alls
• https://autoapi2.18f.gov/swagger-ui/#!/q3_2014_all/get_q3_2014_all
• https://api.18f.gov/sec/q3_2014_all?api_key=DexlaoztDqozOQ7aRgfGBuGCEggaF0AznhfaFXd2

_Note query abilities, such as https://autoapi.18f.gov/q3_2014_alls?McapRank=10&page=2_

_Note API analytics_

SEC Example 2:

• ...
• https://autoapi.18f.gov/iardlist-2s
• https://autoapi2.18f.gov/swagger-ui/#!/iardlist-2/get_iardlist_2

[gbinal]

More fodder - https://www.google.com/webhp?sourceid=chrome-instant&ion=1&espv=2&ie=UTF-8#q=filetype:xls+site:sec.gov

Target files:

Market Activity by Individual Security, 2015 Q3 (zip, 13.7 mb) http://www.sec.gov/opa/data/market-structure/marketstructuredownloadshtml-by_security.html https://autoapi.18f.gov/q3_2015_all-2s

Market Activity by Individual Security and Exchange, 2015 Q2 (zip, 80.7 mb) http://www.sec.gov/opa/data/market-structure/market-structure-data-security-and-exchange.html

Depth in Shares by Individual Security, 2013 (zip 624.1 mb) http://www.sec.gov/data/market-structure/spreads-and-depth-by-individual-security.html

log20150331.zip http://www.sec.gov/data/edgar-log-file-data-set

[gbinal]

WIP:

• source file - source page
• https://autoapi.18f.gov/q3_2015_all-2s
• https://autoapi2.18f.gov/swagger-ui/#!/q3_2015_all-2/get_q3_2015_all_2

[gbinal]

Okay - thank you for your patience. This should in a good place now. You can ignore the above. Here it is in summary:

• You have an s3 bucket and the ability to upload files to it indefinitely. [credentials delivered]
• Cleanly-formatted flat files in the s3 bucket are automatically turned into APIs with a base URL of https://autoapi2.18f.gov/.
• You can explore the endpoints using the swagger documentation at https://autoapi2.18f.gov/.
• These APIs have been integrated into the api.data.gov service. Instead of publishing this URL, you would instead publish this URL. As a result, you can track who is using your API and how.
• Note the ability to run queries against the API [https://api.18f.gov/sec/q3_2014_all?api_key=DEMO_KEY1&McapRank=7&page=3].
• You have admin access with your SEC accounts at https://api.data.gov/admin.
• An example of the API analytics available can be seen here.

This instance is yours to play with through the current period of performance (-9/20/16), however we can and should set you up with your own instance of cloud.gov (sandbox access package) so that you internalize this project and use it indefinitely.