nokey.art_and_images package
Submodules
nokey.art_and_images.artic module
- class nokey.art_and_images.artic.Artic(use_caching=False, cache_name='artic_cache', backend='sqlite', expire_after=3600)[source]
Bases:
objectA class for interacting with the Art Institute of Chicago API.
- base_url
The base URL of the API.
- image_api_url
The base URL for accessing the images in this API.
- about
A short description of the API.
- download_image(image_id)[source]
Downloads a jpg of the image matching the id.
- Parameters:
image_id (str) – The unique identifier for the image. These can be obtained from both the images and exhibitions endpoints of the Artic API.
- Returns:
Downloads an image and returns a string confirming the download.
- Return type:
image, str
- get_agent_by_id(agent_id)[source]
Returns data about a specific agent in the Art Institute of Chicago’s database.
- Parameters:
agent_id (int) – A unique number identifying the agent.
- Returns:
A dictionary containing data about a specific agent.
- Return type:
dict
- get_agent_role_by_id(agent_role_id)[source]
Returns data about a specific agent role in the Art Institute of Chicago’s database.
- Parameters:
agent_role_id (int) – A unique number identifying the agent role.
- Returns:
A dictionary containing data about a specific agent role.
- Return type:
dict
- get_agent_roles_by_fields(fields, page=1, limit=10)[source]
Returns data about all the agent roles contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_agent_roles_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing agent roles data.
- Return type:
dict
- get_agent_roles_data_fields()[source]
Returns the list of agent roles fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_agent_type_by_id(agent_type_id)[source]
Returns data about a specific agent type in the Art Institute of Chicago’s database.
- Parameters:
agent_type_id (int) – A unique number identifying the agent type.
- Returns:
A dictionary containing data about a specific agent type.
- Return type:
dict
- get_agent_types_by_fields(fields, page=1, limit=10)[source]
Returns data about all the agent types contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_agent_types_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing agent types data.
- Return type:
dict
- get_agent_types_data_fields()[source]
Returns the list of agent types fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_agents_by_fields(fields, page=1, limit=10)[source]
Returns data about all the agents contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_agents_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing agents data.
- Return type:
dict
- get_agents_data_fields()[source]
Returns the list of agents fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_all_agent_roles(page=1, limit=10)[source]
Returns data about all the agent roles in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing agent roles data.
- Return type:
dict
- get_all_agent_types(page=1, limit=10)[source]
Returns data about all the agent types in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing agent types data.
- Return type:
dict
- get_all_agents(page=1, limit=10)[source]
Returns data about all the agents in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing agents data.
- Return type:
dict
- get_all_articles(page=1, limit=10)[source]
Returns data about all the articles in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing articles data.
- Return type:
dict
- get_all_artists(page=1, limit=10)[source]
Returns data about all the artists in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artist data.
- Return type:
dict
- get_all_artwork_date_qualifiers(page=1, limit=10)[source]
Returns data about all the artwork date qualifiers in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork date qualifiers data.
- Return type:
dict
- get_all_artwork_place_qualifiers(page=1, limit=10)[source]
Returns data about all the artwork place qualifiers in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork place qualifiers data.
- Return type:
dict
- get_all_artwork_types(page=1, limit=10)[source]
Returns data about all the artwork types in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork type data.
- Return type:
dict
- get_all_artworks(page=1, limit=10)[source]
Returns data about all the artwork at Art Institute of Chicago.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork data.
- Return type:
dict
- get_all_category_terms(page=1, limit=10)[source]
Returns data about all the category terms in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing category terms.
- Return type:
dict
- get_all_digital_catalogs(page=1, limit=10)[source]
Returns data about all the digital catalogs in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing digital catalogs data.
- Return type:
dict
- get_all_digital_publication_sections(page=1, limit=10)[source]
Returns data about all the digital publication sections in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing digital publication sections data.
- Return type:
dict
- get_all_educator_resources(page=1, limit=10)[source]
Returns data about all the educator resources in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing educator resources data.
- Return type:
dict
- get_all_event_occurrences(page=1, limit=10)[source]
Returns data about all the event occurrences in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing event occurrences data.
- Return type:
dict
- get_all_event_programs(page=1, limit=10)[source]
Returns data about all the event programs in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing event programs data.
- Return type:
dict
- get_all_events(page=1, limit=10)[source]
Returns data about all the events in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing events data.
- Return type:
dict
- get_all_exhibitions(page=1, limit=10)[source]
Returns data about all the exhibitions in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing exhibitions data.
- Return type:
dict
- get_all_galleries(page=1, limit=10)[source]
Returns data about all the galleries in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing galleries data.
- Return type:
dict
- get_all_generic_pages(page=1, limit=10)[source]
Returns data about all the generic pages in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing generic pages data.
- Return type:
dict
- get_all_highlights(page=1, limit=10)[source]
Returns data about all the highlights in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing highlights data.
- Return type:
dict
- get_all_images(page=1, limit=10)[source]
Returns data about all the images in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing image data.
- Return type:
dict
- get_all_mobile_sounds(page=1, limit=10)[source]
Returns data about all the mobile sounds in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing mobile sounds data.
- Return type:
dict
- get_all_places(page=1, limit=10)[source]
Returns data about all the places in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing places data.
- Return type:
dict
- get_all_press_releases(page=1, limit=10)[source]
Returns data about all the press releases in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing press releases data.
- Return type:
dict
- get_all_printed_catalogs(page=1, limit=10)[source]
Returns data about all the printed catalogs in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing printed catalogs data.
- Return type:
dict
- get_all_products(page=1, limit=10)[source]
Returns data about all the products in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing products data.
- Return type:
dict
- get_all_publications(page=1, limit=10)[source]
Returns data about all the publications in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing publications data.
- Return type:
dict
- get_all_sections(page=1, limit=10)[source]
Returns data about all the sections in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing sections data.
- Return type:
dict
- get_all_sites(page=1, limit=10)[source]
Returns data about all the sites in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing sites data.
- Return type:
dict
- get_all_sounds(page=1, limit=10)[source]
Returns data about all the sounds in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing sounds data.
- Return type:
dict
- get_all_static_pages(page=1, limit=10)[source]
Returns data about all the static pages in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing static pages data.
- Return type:
dict
- get_all_texts(page=1, limit=10)[source]
Returns data about all the texts in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing texts data.
- Return type:
dict
- get_all_tours(page=1, limit=10)[source]
Returns data about all the tours in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing tours data.
- Return type:
dict
- get_all_videos(page=1, limit=10)[source]
Returns data about all the videos in Art Institute of Chicago database.
- Parameters:
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing videos data.
- Return type:
dict
- get_article_by_id(article_id)[source]
Returns data about a specific article in the Art Institute of Chicago’s database.
- Parameters:
article_id (int) – A unique number identifying the article.
- Returns:
A dictionary containing data about a specific article.
- Return type:
dict
- get_articles_by_fields(fields, page=1, limit=10)[source]
Returns data about all the articles contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_articles_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing articles data.
- Return type:
dict
- get_articles_data_fields()[source]
Returns the list of articles fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_artist_by_id(artist_id)[source]
Returns data about a specific artist in the Art Institute of Chicago’s database.
- Parameters:
artist_id (int) – A unique number identifying the artist
- Returns:
A dictionary containing data about a specific artist.
- Return type:
dict
- get_artists_by_fields(fields, page=1, limit=10)[source]
Returns data about all the artists contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_artists_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artist data.
- Return type:
dict
- get_artists_data_fields()[source]
Returns the list of artist fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_artwork_by_id(artwork_id)[source]
Returns data about a specific artwork in the Art Institute of Chicago’s database.
- Parameters:
artwork_id (int) – A unique number identifying the artwork.
- Returns:
A dictionary containing data about a specific artwork.
- Return type:
dict
- get_artwork_date_qualifier_by_id(artwork_date_qualifier_id)[source]
Returns data about a specific artwork date qualifier in the Art Institute of Chicago’s database.
- Parameters:
artwork_date_qualifier_id (int) – A unique number identifying the artwork date qualifier.
- Returns:
A dictionary containing data about a specific artwork date qualifier.
- Return type:
dict
- get_artwork_date_qualifiers_by_fields(fields, page=1, limit=10)[source]
Returns data about all the artwork date qualifiers contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_artwork_date_qualifiers_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork date qualifiers data.
- Return type:
dict
- get_artwork_date_qualifiers_data_fields()[source]
Returns the list of artwork date qualifiers fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_artwork_place_qualifier_by_id(artwork_place_qualifier_id)[source]
Returns data about a specific artwork place qualifier in the Art Institute of Chicago’s database.
- Parameters:
artwork_place_qualifier_id (int) – A unique number identifying the artwork place qualifier.
- Returns:
A dictionary containing data about a specific artwork place qualifier.
- Return type:
dict
- get_artwork_place_qualifiers_by_fields(fields, page=1, limit=10)[source]
Returns data about all the artwork place qualifiers contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_artwork_place_qualifiers_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork place qualifiers data.
- Return type:
dict
- get_artwork_place_qualifiers_data_fields()[source]
Returns the list of artwork place qualifiers fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_artwork_type_by_id(artwork_type_id)[source]
Returns data about a specific artwork type in the Art Institute of Chicago’s database.
- Parameters:
artwork_type_id (int) – A unique number identifying the artwork type.
- Returns:
A dictionary containing data about a specific artwork type.
- Return type:
dict
- get_artwork_types_by_fields(fields, page=1, limit=10)[source]
Returns data about all the artwork types contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_artwork_types_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork types data.
- Return type:
dict
- get_artwork_types_data_fields()[source]
Returns the list of artwork types fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_artworks_by_fields(fields, page=1, limit=10)[source]
Returns data about all the artwork contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_artworks_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing artwork data.
- Return type:
dict
- get_artworks_data_fields()[source]
Returns the list of artwork fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_category_term_by_id(category_term_id)[source]
Returns data about a specific category term in the Art Institute of Chicago’s database.
- Parameters:
category_term_id (str) – A unique id identifying the category term.
- Returns:
A dictionary containing data about a specific category term.
- Return type:
dict
- get_category_terms_by_fields(fields, page=1, limit=10)[source]
Returns data about all the category terms contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_category_terms_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing category terms data.
- Return type:
dict
- get_category_terms_data_fields()[source]
Returns the list of category terms fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_digital_catalog_by_id(digital_catalog_id)[source]
Returns data about a specific digital catalog in the Art Institute of Chicago’s database.
- Parameters:
digital_catalog_id (int) – A unique number identifying the digital catalog.
- Returns:
A dictionary containing data about a specific digital catalog.
- Return type:
dict
- get_digital_catalogs_by_fields(fields, page=1, limit=10)[source]
Returns data about all the digital catalogs in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_digital_catalogs_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing digital catalogs data.
- Return type:
dict
- get_digital_catalogs_data_fields()[source]
Returns the list of digital catalogs fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_digital_publication_section_by_id(digital_publication_section_id)[source]
Returns data about a specific digital publication section in the Art Institute of Chicago’s database.
- Parameters:
digital_publication_section_id (int) – A unique number identifying the digital publication section.
- Returns:
A dictionary containing data about a specific digital publication section.
- Return type:
dict
- get_digital_publication_sections_by_fields(fields, page=1, limit=10)[source]
Returns data about all the digital publication sections in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_digital_publication_sections_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing digital publication sections data.
- Return type:
dict
- get_digital_publication_sections_data_fields()[source]
Returns the list of digital publication sections fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_docs_url()[source]
Returns the URL for the Art Institute of Chicago API documentation.
- Parameters:
None –
- Returns:
The URL for the API docs.
- Return type:
string
- get_educator_resource_by_id(educator_resource_id)[source]
Returns data about a specific educator resource in the Art Institute of Chicago’s database.
- Parameters:
educator_resource_id (int) – A unique number identifying the educator resource.
- Returns:
A dictionary containing data about a specific educator resource.
- Return type:
dict
- get_educator_resources_by_fields(fields, page=1, limit=10)[source]
Returns data about all the educator resources contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_educator_resources_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing educator resources data.
- Return type:
dict
- get_educator_resources_data_fields()[source]
Returns the list of educator resources fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_event_by_id(event_id)[source]
Returns data about a specific event in the Art Institute of Chicago’s database.
- Parameters:
event_id (int) – A unique number identifying the event.
- Returns:
A dictionary containing data about a specific event.
- Return type:
dict
- get_event_occurrence_by_id(event_occurrence_id)[source]
Returns data about a specific event occurrence in the Art Institute of Chicago’s database.
- Parameters:
event_occurrence_id (str) – A unique id identifying the event occurrence.
- Returns:
A dictionary containing data about a specific event occurrence.
- Return type:
dict
- get_event_occurrences_by_fields(fields, page=1, limit=10)[source]
Returns data about all the event occurrences contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_events_occurrences_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing event occurrences data.
- Return type:
dict
- get_event_occurrences_data_fields()[source]
Returns the list of event occurrences fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields
- Return type:
object
- get_event_program_by_id(event_program_id)[source]
Returns data about a specific event program in the Art Institute of Chicago’s database.
- Parameters:
event_program_id (int) – A unique number identifying the event program.
- Returns:
A dictionary containing data about a specific event program.
- Return type:
dict
- get_event_programs_by_fields(fields, page=1, limit=10)[source]
Returns data about all the event programs contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_events_programs_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing event programs data.
- Return type:
dict
- get_event_programs_data_fields()[source]
Returns the list of event programs fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_events_by_fields(fields, page=1, limit=10)[source]
Returns data about all the events contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_events_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing events data.
- Return type:
dict
- get_events_data_fields()[source]
Returns the list of events fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields
- Return type:
object
- get_exhibition_by_id(exhibition_id)[source]
Returns data about a specific exhibition in the Art Institute of Chicago’s database.
- Parameters:
exhibition_id (int) – A unique number identifying the exhibition.
- Returns:
A dictionary containing data about a specific exhibition.
- Return type:
dict
- get_exhibitions_by_fields(fields, page=1, limit=10)[source]
Returns data about all the exhibitions contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_exhibitions_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing exhibitions data.
- Return type:
dict
- get_exhibitions_data_fields()[source]
Returns the list of exhibitions fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_galleries_by_fields(fields, page=1, limit=10)[source]
Returns data about all the galleries contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_galleries_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing galleries data.
- Return type:
dict
- get_galleries_data_fields()[source]
Returns the list of galleries fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_gallery_by_id(gallery_id)[source]
Returns data about a specific gallery in the Art Institute of Chicago’s database.
- Parameters:
agent_id (int) – A unique number identifying the gallery.
- Returns:
A dictionary containing data about a specific gallery.
- Return type:
dict
- get_generic_page_by_id(generic_page_id)[source]
Returns data about a specific generic page in the Art Institute of Chicago’s database.
- Parameters:
generic_page_id (int) – A unique number identifying the generic page.
- Returns:
A dictionary containing data about a specific generic page.
- Return type:
dict
- get_generic_pages_by_fields(fields, page=1, limit=10)[source]
Returns data about all the generic pages contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_generic_pages_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing generic pages data.
- Return type:
dict
- get_generic_pages_data_fields()[source]
Returns the list of generic pages fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_highlight_by_id(highlight_id)[source]
Returns data about a specific highlight in the Art Institute of Chicago’s database.
- Parameters:
highlight_id (int) – A unique number identifying the highlight.
- Returns:
A dictionary containing data about a specific highlight.
- Return type:
dict
- get_highlights_by_fields(fields, page=1, limit=10)[source]
Returns data about all the highlights contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_highlights_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing highlights data.
- Return type:
dict
- get_highlights_data_fields()[source]
Returns the list of highlights fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_image_by_id(image_id)[source]
Returns data about a specific image in the Art Institute of Chicago’s database.
- Parameters:
image_id (str) – A unique id identifying the image.
- Returns:
A dictionary containing data about a specific image.
- Return type:
dict
- get_images_by_fields(fields, page=1, limit=10)[source]
Returns data about all the images contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_images_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing images data.
- Return type:
dict
- get_images_data_fields()[source]
Returns the list of images fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_mobile_sound_by_id(mobile_sound_id)[source]
Returns data about a specific mobile sound in the Art Institute of Chicago’s database.
- Parameters:
mobile_sound_id (int) – A unique number identifying the mobile sound.
- Returns:
A dictionary containing data about a specific mobile sound.
- Return type:
dict
- get_mobile_sounds_by_fields(fields, page=1, limit=10)[source]
Returns data about all the mobile sounds contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_mobile_sounds_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing mobile sounds data.
- Return type:
dict
- get_mobile_sounds_data_fields()[source]
Returns the list of mobile sounds fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields
- Return type:
object
- get_place_by_id(place_id)[source]
Returns data about a specific place in the Art Institute of Chicago’s database.
- Parameters:
place_id (negative int) – A unique (negative) number identifying the place.
- Returns:
A dictionary containing data about a specific place.
- Return type:
dict
- get_places_by_fields(fields, page=1, limit=10)[source]
Returns data about all the places contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_places_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing places data.
- Return type:
dict
- get_places_data_fields()[source]
Returns the list of places fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_press_release_by_id(press_release_id)[source]
Returns data about a specific press release in the Art Institute of Chicago’s database.
- Parameters:
press_release_id (int) – A unique number identifying the press release.
- Returns:
A dictionary containing data about a specific press release.
- Return type:
dict
- get_press_releases_by_fields(fields, page=1, limit=10)[source]
Returns data about all the press releases contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_press_releases_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing press releases data.
- Return type:
dict
- get_press_releases_data_fields()[source]
Returns the list of press releases fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_printed_catalog_by_id(printed_catalog_id)[source]
Returns data about a specific printed catalog in the Art Institute of Chicago’s database.
- Parameters:
printed_catalog_id (int) – A unique number identifying the printed catalog.
- Returns:
A dictionary containing data about a specific printed catalog.
- Return type:
dict
- get_printed_catalogs_by_fields(fields, page=1, limit=10)[source]
Returns data about all the printed catalogs in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_printed_catalogs_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing printed catalogs data.
- Return type:
dict
- get_printed_catalogs_data_fields()[source]
Returns the list of printed catalogs fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_product_by_id(product_id)[source]
Returns data about a specific product in the Art Institute of Chicago’s database.
- Parameters:
product_id (int) – A unique number identifying the product.
- Returns:
A dictionary containing data about a specific product.
- Return type:
dict
- get_products_by_fields(fields, page=1, limit=10)[source]
Returns data about all the products contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_products_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing products data.
- Return type:
dict
- get_products_data_fields()[source]
Returns the list of products fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_publication_by_id(publication_id)[source]
Returns data about a specific publication in the Art Institute of Chicago’s database.
- Parameters:
publication_id (int) – A unique number identifying the publication.
- Returns:
A dictionary containing data about a specific publication.
- Return type:
dict
- get_publications_by_fields(fields, page=1, limit=10)[source]
Returns data about all the publications contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_publications_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing publications data.
- Return type:
dict
- get_publications_data_fields()[source]
Returns the list of publications fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields
- Return type:
object
- get_section_by_id(section_id)[source]
Returns data about a specific section in the Art Institute of Chicago’s database.
- Parameters:
section_id (int) – A unique number identifying the publication.
- Returns:
A dictionary containing data about a specific section.
- Return type:
dict
- get_sections_by_fields(fields, page=1, limit=10)[source]
Returns data about all the sections contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_sections_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing sections data.
- Return type:
dict
- get_sections_data_fields()[source]
Returns the list of sections fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields
- Return type:
object
- get_site_by_id(site_id)[source]
Returns data about a specific site in the Art Institute of Chicago’s database.
- Parameters:
site_id (int) – A unique number identifying the site.
- Returns:
A dictionary containing data about a specific site.
- Return type:
dict
- get_sites_by_fields(fields, page=1, limit=10)[source]
Returns data about all the sites contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_sites_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing sites data.
- Return type:
dict
- get_sites_data_fields()[source]
Returns the list of sites fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields
- Return type:
object
- get_sound_by_id(sound_id)[source]
Returns data about a specific sound in the Art Institute of Chicago’s database.
- Parameters:
sound_id (str) – A unique id identifying the sound.
- Returns:
A dictionary containing data about a specific sound.
- Return type:
dict
- get_sounds_by_fields(fields, page=1, limit=10)[source]
Returns data about all the sounds contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_sounds_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing sounds data.
- Return type:
dict
- get_sounds_data_fields()[source]
Returns the list of sounds fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_static_page_by_id(static_page_id)[source]
Returns data about a specific static page in the Art Institute of Chicago’s database.
- Parameters:
static_page_id (int) – A unique number identifying the static page.
- Returns:
A dictionary containing data about a specific static page.
- Return type:
dict
- get_static_pages_by_fields(fields, page=1, limit=10)[source]
Returns data about all the static pages contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_static_pages_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing static pages data.
- Return type:
dict
- get_static_pages_data_fields()[source]
Returns the list of static pages fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_text_by_id(text_id)[source]
Returns data about a specific text in the Art Institute of Chicago’s database.
- Parameters:
text_id (str) – A unique id identifying the text.
- Returns:
A dictionary containing data about a specific text.
- Return type:
dict
- get_texts_by_fields(fields, page=1, limit=10)[source]
Returns data about all the texts contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_texts_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing texts data.
- Return type:
dict
- get_texts_data_fields()[source]
Returns the list of texts fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_tour_by_id(tour_id)[source]
Returns data about a specific tour in the Art Institute of Chicago’s database.
- Parameters:
tour_id (int) – A unique number identifying the tour.
- Returns:
A dictionary containing data about a specific tour.
- Return type:
dict
- get_tours_by_fields(fields, page=1, limit=10)[source]
Returns data about all the tours contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_tours_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing tours data.
- Return type:
dict
- get_tours_data_fields()[source]
Returns the list of tours fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- get_video_by_id(video_id)[source]
Returns data about a specific video in the Art Institute of Chicago’s database.
- Parameters:
video_id (str) – A unique id identifying the video.
- Returns:
A dictionary containing data about a specific video.
- Return type:
dict
- get_videos_by_fields(fields, page=1, limit=10)[source]
Returns data about all the videos contained in the ARTIC database, but only by the specified fields.
- Parameters:
field (str) – A comma separated, no spaced string of field names. For retrieving only certain fields. Call get_videos_data_fields function to get the available fields.
page (int) – Pagination parameter. Defaults to first page.
limit (int) – Number of results per page. Default is 10.
- Returns:
A dictionary containing videos data.
- Return type:
dict
- get_videos_data_fields()[source]
Returns the list of videos fields (dictionary keys) used in the ARTIC database.
- Parameters:
None –
- Returns:
A dict_keys object containing a list of the fields.
- Return type:
object
- search_agent_roles(query, page=1, limit=10)[source]
Returns data about agent roles in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about agent roles.
- Return type:
dict
- search_agent_types(query, page=1, limit=10)[source]
Returns data about agent types in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about agent types.
- Return type:
dict
- search_agents(query, page=1, limit=10)[source]
Returns data about agents in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about agents.
- Return type:
dict
- search_articles(query, page=1, limit=10)[source]
Returns data about articles in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about articles.
- Return type:
dict
- search_artists(query, page=1, limit=10)[source]
Returns data about artists in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about artists
- Return type:
dict
- search_artwork_date_qualifiers(query, page=1, limit=10)[source]
Returns data about artwork date qualifiers in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about artwork date qualifiers.
- Return type:
dict
- search_artwork_place_qualifiers(query, page=1, limit=10)[source]
Returns data about artwork place qualifiers in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about artwork place qualifiers.
- Return type:
dict
- search_artwork_types(query, page=1, limit=10)[source]
Returns data about artwork types in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about artwork types.
- Return type:
dict
- search_artworks(query, page=1, limit=10)[source]
Returns data about a artwork in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about artwork.
- Return type:
dict
- search_category_terms(query, page=1, limit=10)[source]
Returns data about category terms in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about category terms.
- Return type:
dict
- search_digital_catalogs(query, page=1, limit=10)[source]
Returns data about digital catalogs in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about digital catalogs.
- Return type:
dict
- search_digital_publication_sections(query, page=1, limit=10)[source]
Returns data about digital publication sections in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about digital publication sections.
- Return type:
dict
- search_educator_resources(query, page=1, limit=10)[source]
Returns data about educator resources in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about educator resources.
- Return type:
dict
- search_event_occurrences(query, page=1, limit=10)[source]
Returns data about event occurrences in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about event occurrences.
- Return type:
dict
- search_event_programs(query, page=1, limit=10)[source]
Returns data about event programs in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about event programs.
- Return type:
dict
- search_events(query, page=1, limit=10)[source]
Returns data about events in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about events.
- Return type:
dict
- search_exhibitions(query, page=1, limit=10)[source]
Returns data about exhibitions in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about exhibitions.
- Return type:
dict
- search_galleries(query, page=1, limit=10)[source]
Returns data about galleries in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about galleries.
- Return type:
dict
- search_generic_pages(query, page=1, limit=10)[source]
Returns data about generic pages in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about generic pages.
- Return type:
dict
- search_highlights(query, page=1, limit=10)[source]
Returns data about highlights in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about highlights.
- Return type:
dict
- search_images(query, page=1, limit=10)[source]
Returns data about images in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about images.
- Return type:
dict
- search_mobile_sounds(query, page=1, limit=10)[source]
Returns data about mobile sounds in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about mobile sounds.
- Return type:
dict
- search_places(query, page=1, limit=10)[source]
Returns data about places in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about places.
- Return type:
dict
- search_press_releases(query, page=1, limit=10)[source]
Returns data about press releases in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about press releases.
- Return type:
dict
- search_printed_catalogs(query, page=1, limit=10)[source]
Returns data about printed catalogs in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about printed catalogs.
- Return type:
dict
- search_products(query, page=1, limit=10)[source]
Returns data about products in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about products.
- Return type:
dict
- search_publications(query, page=1, limit=10)[source]
Returns data about publications in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about publications.
- Return type:
dict
- search_sections(query, page=1, limit=10)[source]
Returns data about sections in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about sections.
- Return type:
dict
- search_sites(query, page=1, limit=10)[source]
Returns data about sites in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about sites.
- Return type:
dict
- search_sounds(query, page=1, limit=10)[source]
Returns data about sounds in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about sounds.
- Return type:
dict
- search_static_pages(query, page=1, limit=10)[source]
Returns data about static pages in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about static pages.
- Return type:
dict
- search_texts(query, page=1, limit=10)[source]
Returns data about texts in the Art Institute of Chicago’s database matching the specified query term and field values.
- Parameters:
query (str) – A search term.
- Returns:
A dictionary containing data about texts.
- Return type:
dict
nokey.art_and_images.lorem_picsum module
- class nokey.art_and_images.lorem_picsum.LoremPicsum(use_caching=False, cache_name='lorem_picsum_cache', backend='sqlite', expire_after=3600)[source]
Bases:
objectA class for interacting with the Lorem Picsum API.
- base_url
The base URL of the API.
- about
A short description of the API.
- get_docs_url()[source]
Returns the URL for the Lorem Picsum API documentation.
- Parameters:
None –
- Returns:
The URL for the API docs.
- Return type:
string
- get_image_by_id(image_id, width, height=None, grayscale=False, blur=None)[source]
Returns the URL for a specific image matching the given id number.
- Parameters:
image_id (int) – A unique numerical id matching a specific image.
width (int) – The width of the image.
height (int) – The height of the image. Defaults to None in which case the image is square.
- Returns:
The URL to the image matching the given parameters.
- Return type:
string
- get_image_info_by_id(image_id)[source]
Returns info about a specific image matching the given id.
- Parameters:
image_id (int) – A number matching a specific image.
- Returns:
A dictionary containing info about a specific image.
- Return type:
dict
- get_image_info_by_seed(seed)[source]
Returns info about a specific image matching the given seed.
- Parameters:
seed (str) – The seed matching a specific image.
- Returns:
A dictionary containing info about a specific image.
- Return type:
dict
- get_random_image(width, height=None, grayscale=False, blur=None)[source]
Returns the URL for to a random placeholder image with the given dimensions.
- Parameters:
width (int) – The width of the image.
height (int) – The height of the image. Defaults to None in which case the image is square.
grayscale (bool) – Optional argument for returning a grayscale picture. The default value is False.
blur (int) – An option to return a blurred photo. Values range from 1 to 10.
- Returns:
The URL of the placeholder image.
- Return type:
string
- get_static_random_image(seed, width, height=None, grayscale=False, blur=None)[source]
Returns the URL for to a random placeholder image with the given dimensions.
- Parameters:
seed (str) – A seed term to ensure the same random image is returned each time.
width (int) – The width of the image.
height (int) – The height of the image. Defaults to None in which case the image is square.
- Returns:
The URL of the placeholder image.
- Return type:
string