Documentation
¶
Overview ¶
Package propublica is the library behind the propublica command line: the HTTP client, request shaping, and the typed data models for the ProPublica Nonprofit Explorer API.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "propublica-cli/dev (+https://github.com/tamnd/propublica-cli)"
DefaultUserAgent identifies the client to ProPublica.
const Host = "projects.propublica.org"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
BaseURL string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to ProPublica Nonprofit Explorer over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with the default config applied.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings.
type Config ¶
Config holds the client settings.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns sensible defaults for the ProPublica API.
type Domain ¶
type Domain struct{}
Domain is the propublica driver.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
type Organization ¶
type Organization struct {
EIN int `json:"ein" kit:"id"`
Name string `json:"name"`
City string `json:"city"`
State string `json:"state"`
NTEECode string `json:"ntee_code"`
URL string `json:"url"`
LatestYear int `json:"latest_year,omitempty"`
Revenue int64 `json:"revenue,omitempty"`
Expenses int64 `json:"expenses,omitempty"`
}
Organization is a US nonprofit from IRS 990 filings. The LatestYear, Revenue, and Expenses fields are populated from the most recent filing when the data is available (org command); they are zero for search results.
Source Files