{"ok":true,"site":"data-cityofnewyork","host":"data.cityofnewyork.us","about":"NYC Open Data (Socrata catalog at data.cityofnewyork.us). The CLI searches the dataset catalog by keyword, tag, category and sort order; reads dataset metadata and columns; runs SoQL queries against rows; exports CSV; and lists change history and attachments. It needs no login.","commands":[{"command":"search-datasets","summary":"Search the NYC Open Data catalog by keyword, tag, category or asset type, with sorting and offset paging","params":[{"name":"q","type":"string","description":"Free-text search keywords. Omit or leave empty to browse everything."},{"name":"tags","type":"string","description":"Filter by a catalog tag, e.g. food, restaurant, taxi."},{"name":"categories","type":"string","description":"Filter by domain category. The values come from list-catalog-facets.","oneOf":["Housing & Development","City Government","Health","Education","Recreation","Transportation","Social Services","Public Safety","Environment","Business"]},{"name":"only","type":"string","description":"Restrict results to one asset type.","oneOf":["dataset","map","chart","file","href","filter"]},{"name":"order","type":"string","description":"Sort order. page_views_total means most viewed.","oneOf":["relevance","page_views_total","name","updatedAt","createdAt"],"default":"relevance"},{"name":"api_limit","type":"number","description":"Number of results per page. (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":20},{"name":"offset","type":"number","description":"Zero-based result offset, used for paging.","default":0}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/search-datasets?q=restaurant&tags=food"},{"command":"suggest-dataset-titles","summary":"Autocomplete dataset titles that match a partial keyword","params":[{"name":"q","type":"string","required":true,"description":"Partial search text."},{"name":"api_limit","type":"number","description":"Maximum number of suggestions. (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":6}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/suggest-dataset-titles?q=taxi"},{"command":"list-catalog-facets","summary":"List the catalog's browse facets: domain categories and custom facets such as Data Collection, with their options","params":[],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/list-catalog-facets"},{"command":"get-dataset","summary":"Get full metadata for a dataset by its 4x4 id: name, description, agency, category, view and download counts, update times and column definitions","params":[{"name":"id","type":"string","required":true,"description":"Dataset id in 4x4 form, e.g. 43nn-pn8j."}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/get-dataset"},{"command":"query-dataset","summary":"Run a SoQL query against a dataset's rows: select, filter, aggregate, count, or page with LIMIT/OFFSET","params":[{"name":"id","type":"string","required":true,"description":"Dataset id in 4x4 form, e.g. 8meu-9t5y."},{"name":"query","type":"string","required":true,"description":"SoQL query with no FROM clause. Use column field names from get-dataset (columns[].fieldName), backtick-quoted if needed. Examples: \"SELECT `zone`, `borough` WHERE `borough`='Queens' LIMIT 10 OFFSET 1"}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/query-dataset"},{"command":"export-dataset-csv","summary":"Download the entire dataset as CSV text (this can be very large for big datasets)","params":[{"name":"id","type":"string","required":true,"description":"Dataset id in 4x4 form."}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/export-dataset-csv"},{"command":"list-dataset-changes","summary":"List a dataset's update/version history (archive entries with version number and timestamp), using cursor paging","params":[{"name":"id","type":"string","required":true,"description":"Dataset id in 4x4 form."},{"name":"api_limit","type":"number","description":"Entries per page. (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":10},{"name":"cursor","type":"string","description":"Cursor from meta.next of the previous page. Leave empty for the first page."}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/list-dataset-changes"},{"command":"list-dataset-attachments","summary":"List the file ids of a dataset's attachments (data dictionaries, user guides) with their scan state","params":[{"name":"id","type":"string","required":true,"description":"Dataset id in 4x4 form."}],"exampleUrl":"https://clify-dev.netlify.app/data-cityofnewyork/list-dataset-attachments"}]}