Skip to content

MunicipalityApi.md

Latest commit

 

History

History
278 lines (166 loc) · 7.08 KB

MunicipalityApi.md

File metadata and controls

278 lines (166 loc) · 7.08 KB

intrinioSDK.MunicipalityApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
getAllMunicipalities GET /municipalities All Municipalities
getMunicipalityById GET /municipalities/{id} Municipality by ID
getMunicipalityFinancials GET /municipalities/{id}/financials Financials for a Municipality

getAllMunicipalities

View Intrinio API Documentation

ApiResponseMunicipalities getAllMunicipalities(opts)

All Municipalities

Returns all Municipalities. When parameters are specified, returns matching municipalities.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var municipality = new intrinioSDK.MunicipalityApi();

var opts = { 
  'hasFinancials': null,
  'governmentName': null,
  'governmentType': null,
  'areaName': null,
  'areaType': null,
  'city': null,
  'state': null,
  'zipcode': null,
  'populationGreaterThan': null,
  'populationLessThan': null,
  'enrollmentGreaterThan': null,
  'enrollmentLessThan': null,
  'nextPage': null
};

municipality.getAllMunicipalities(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
hasFinancials Boolean Return municipalities with financials [optional]  
governmentName String Return municipalities with a government name matching the given query [optional]  
governmentType String Return municipalities with the given government type [optional]  
areaName String Return municipalities with an area name matching the given query [optional]  
areaType String Return municipalities with the given area type [optional]  
city String Return municipalities in the given city [optional]  
state String Return municipalities in the given state [optional]  
zipcode Number Return municipalities in the given zipcode [optional]  
populationGreaterThan Number Return municipalities with a population greater than the given number [optional]  
populationLessThan Number Return municipalities with a population less than the given number [optional]  
enrollmentGreaterThan Number Return municipalities with an enrollment greater than the given number [optional]  
enrollmentLessThan Number Return municipalities with an enrollment less than the given number [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseMunicipalities

getMunicipalityById

View Intrinio API Documentation

Municipality getMunicipalityById(id)

Municipality by ID

Returns the Municipality with the given ID

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var municipality = new intrinioSDK.MunicipalityApi();

var id = "mun_Xn7x4z";


municipality.getMunicipalityById(id).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String An Intrinio ID of a Municipality  

Return type

Municipality

getMunicipalityFinancials

View Intrinio API Documentation

ApiResponseMunicipalitiyFinancials getMunicipalityFinancials(id, opts)

Financials for a Municipality

Returns financial statement data for the Municipality with the given ID

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var municipality = new intrinioSDK.MunicipalityApi();

var id = "mun_Xn7x4z";


var opts = { 
  'fiscalYear': 2017
};

municipality.getMunicipalityFinancials(id, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String An Intrinio ID of a Municipality  
fiscalYear Number Return financials for the given fiscal year [optional]  

Return type

ApiResponseMunicipalitiyFinancials