PDS API Client (Python)

This is an application programmer’s interface (API) in Python to the Planetary Data System (PDS) ReST API.

Sitemap

Contents

• Quickstart for the PDS API Python Client
  • Prerequisites
  • Installation
  • Create an API Connection
  • Request One End Point
  • Reference Documentation
• Package Reference
  • pds package
    • Subpackages
      • pds.api_client package
        • Subpackages
          • pds.api_client.api package
            • Submodules
              • pds.api_client.api.all_docs_api module
                • AllDocsApi
                  • AllDocsApi.docs()
                  • AllDocsApi.docs_with_http_info()
                  • AllDocsApi.docs_without_preload_content()
              • pds.api_client.api.all_products_api module
                • AllProductsApi
                  • AllProductsApi.product_list()
                  • AllProductsApi.product_list_with_http_info()
                  • AllProductsApi.product_list_without_preload_content()
                  • AllProductsApi.product_properties_list()
                  • AllProductsApi.product_properties_list_with_http_info()
                  • AllProductsApi.product_properties_list_without_preload_content()
                  • AllProductsApi.select_by_lidvid()
                  • AllProductsApi.select_by_lidvid_all()
                  • AllProductsApi.select_by_lidvid_all_with_http_info()
                  • AllProductsApi.select_by_lidvid_all_without_preload_content()
                  • AllProductsApi.select_by_lidvid_latest()
                  • AllProductsApi.select_by_lidvid_latest_with_http_info()
                  • AllProductsApi.select_by_lidvid_latest_without_preload_content()
                  • AllProductsApi.select_by_lidvid_with_http_info()
                  • AllProductsApi.select_by_lidvid_without_preload_content()
              • pds.api_client.api.by_product_classes_api module
                • ByProductClassesApi
                  • ByProductClassesApi.class_list()
                  • ByProductClassesApi.class_list_with_http_info()
                  • ByProductClassesApi.class_list_without_preload_content()
                  • ByProductClassesApi.classes()
                  • ByProductClassesApi.classes_with_http_info()
                  • ByProductClassesApi.classes_without_preload_content()
              • pds.api_client.api.healthcheck_api module
                • HealthcheckApi
                  • HealthcheckApi.healthcheck()
                  • HealthcheckApi.healthcheck_with_http_info()
                  • HealthcheckApi.healthcheck_without_preload_content()
              • pds.api_client.api.product_references_api module
                • ProductReferencesApi
                  • ProductReferencesApi.product_member_of()
                  • ProductReferencesApi.product_member_of_of()
                  • ProductReferencesApi.product_member_of_of_vers()
                  • ProductReferencesApi.product_member_of_of_vers_with_http_info()
                  • ProductReferencesApi.product_member_of_of_vers_without_preload_content()
                  • ProductReferencesApi.product_member_of_of_with_http_info()
                  • ProductReferencesApi.product_member_of_of_without_preload_content()
                  • ProductReferencesApi.product_member_of_vers()
                  • ProductReferencesApi.product_member_of_vers_with_http_info()
                  • ProductReferencesApi.product_member_of_vers_without_preload_content()
                  • ProductReferencesApi.product_member_of_with_http_info()
                  • ProductReferencesApi.product_member_of_without_preload_content()
                  • ProductReferencesApi.product_members()
                  • ProductReferencesApi.product_members_members()
                  • ProductReferencesApi.product_members_members_vers()
                  • ProductReferencesApi.product_members_members_vers_with_http_info()
                  • ProductReferencesApi.product_members_members_vers_without_preload_content()
                  • ProductReferencesApi.product_members_members_with_http_info()
                  • ProductReferencesApi.product_members_members_without_preload_content()
                  • ProductReferencesApi.product_members_vers()
                  • ProductReferencesApi.product_members_vers_with_http_info()
                  • ProductReferencesApi.product_members_vers_without_preload_content()
                  • ProductReferencesApi.product_members_with_http_info()
                  • ProductReferencesApi.product_members_without_preload_content()
            • Module contents
          • pds.api_client.models package
            • Submodules
              • pds.api_client.models.error_message module
                • ErrorMessage
                  • ErrorMessage.from_dict()
                  • ErrorMessage.from_json()
                  • ErrorMessage.message
                  • ErrorMessage.model_config
                  • ErrorMessage.request
                  • ErrorMessage.to_dict()
                  • ErrorMessage.to_json()
                  • ErrorMessage.to_str()
              • pds.api_client.models.metadata module
                • Metadata
                  • Metadata.archive_status
                  • Metadata.creation_date_time
                  • Metadata.from_dict()
                  • Metadata.from_json()
                  • Metadata.label_url
                  • Metadata.model_config
                  • Metadata.to_dict()
                  • Metadata.to_json()
                  • Metadata.to_str()
                  • Metadata.update_date_time
                  • Metadata.version
              • pds.api_client.models.pds4_metadata module
                • Pds4Metadata
                  • Pds4Metadata.from_dict()
                  • Pds4Metadata.from_json()
                  • Pds4Metadata.model_config
                  • Pds4Metadata.node_name
                  • Pds4Metadata.ops_data_files
                  • Pds4Metadata.ops_label_file_info
                  • Pds4Metadata.ops_tracking_meta
                  • Pds4Metadata.to_dict()
                  • Pds4Metadata.to_json()
                  • Pds4Metadata.to_str()
              • pds.api_client.models.pds4_metadata_ops_data_file module
                • Pds4MetadataOpsDataFile
                  • Pds4MetadataOpsDataFile.from_dict()
                  • Pds4MetadataOpsDataFile.from_json()
                  • Pds4MetadataOpsDataFile.model_config
                  • Pds4MetadataOpsDataFile.opscreation_date
                  • Pds4MetadataOpsDataFile.opsfile_name
                  • Pds4MetadataOpsDataFile.opsfile_ref
                  • Pds4MetadataOpsDataFile.opsfile_size
                  • Pds4MetadataOpsDataFile.opsmd5_checksum
                  • Pds4MetadataOpsDataFile.opsmime_type
                  • Pds4MetadataOpsDataFile.to_dict()
                  • Pds4MetadataOpsDataFile.to_json()
                  • Pds4MetadataOpsDataFile.to_str()
              • pds.api_client.models.pds4_metadata_ops_label_file_info module
                • Pds4MetadataOpsLabelFileInfo
                  • Pds4MetadataOpsLabelFileInfo.from_dict()
                  • Pds4MetadataOpsLabelFileInfo.from_json()
                  • Pds4MetadataOpsLabelFileInfo.model_config
                  • Pds4MetadataOpsLabelFileInfo.opscreation_date
                  • Pds4MetadataOpsLabelFileInfo.opsfile_name
                  • Pds4MetadataOpsLabelFileInfo.opsfile_ref
                  • Pds4MetadataOpsLabelFileInfo.opsfile_size
                  • Pds4MetadataOpsLabelFileInfo.opsmd5_checksum
                  • Pds4MetadataOpsLabelFileInfo.to_dict()
                  • Pds4MetadataOpsLabelFileInfo.to_json()
                  • Pds4MetadataOpsLabelFileInfo.to_str()
              • pds.api_client.models.pds4_metadata_ops_tracking_meta module
                • Pds4MetadataOpsTrackingMeta
                  • Pds4MetadataOpsTrackingMeta.from_dict()
                  • Pds4MetadataOpsTrackingMeta.from_json()
                  • Pds4MetadataOpsTrackingMeta.model_config
                  • Pds4MetadataOpsTrackingMeta.opsarchive_status
                  • Pds4MetadataOpsTrackingMeta.to_dict()
                  • Pds4MetadataOpsTrackingMeta.to_json()
                  • Pds4MetadataOpsTrackingMeta.to_str()
              • pds.api_client.models.pds4_product module
                • Pds4Product
                  • Pds4Product.from_dict()
                  • Pds4Product.from_json()
                  • Pds4Product.id
                  • Pds4Product.metadata
                  • Pds4Product.model_config
                  • Pds4Product.pds4
                  • Pds4Product.to_dict()
                  • Pds4Product.to_json()
                  • Pds4Product.to_str()
              • pds.api_client.models.pds4_products module
                • Pds4Products
                  • Pds4Products.data
                  • Pds4Products.from_dict()
                  • Pds4Products.from_json()
                  • Pds4Products.model_config
                  • Pds4Products.summary
                  • Pds4Products.to_dict()
                  • Pds4Products.to_json()
                  • Pds4Products.to_str()
              • pds.api_client.models.pds_product module
                • PdsProduct
                  • PdsProduct.description
                  • PdsProduct.from_dict()
                  • PdsProduct.from_json()
                  • PdsProduct.id
                  • PdsProduct.investigations
                  • PdsProduct.metadata
                  • PdsProduct.model_config
                  • PdsProduct.observing_system_components
                  • PdsProduct.properties
                  • PdsProduct.start_date_time
                  • PdsProduct.stop_date_time
                  • PdsProduct.targets
                  • PdsProduct.title
                  • PdsProduct.to_dict()
                  • PdsProduct.to_json()
                  • PdsProduct.to_str()
                  • PdsProduct.type
              • pds.api_client.models.pds_products module
                • PdsProducts
                  • PdsProducts.data
                  • PdsProducts.from_dict()
                  • PdsProducts.from_json()
                  • PdsProducts.model_config
                  • PdsProducts.summary
                  • PdsProducts.to_dict()
                  • PdsProducts.to_json()
                  • PdsProducts.to_str()
              • pds.api_client.models.properties_list_inner module
                • PropertiesListInner
                  • PropertiesListInner.from_dict()
                  • PropertiesListInner.from_json()
                  • PropertiesListInner.model_config
                  • PropertiesListInner.to_dict()
                  • PropertiesListInner.to_json()
                  • PropertiesListInner.to_str()
                  • PropertiesListInner.type
                  • PropertiesListInner.type_validate_enum()
                  • PropertiesListInner.var_property
              • pds.api_client.models.reference module
                • Reference
                  • Reference.description
                  • Reference.from_dict()
                  • Reference.from_json()
                  • Reference.href
                  • Reference.id
                  • Reference.model_config
                  • Reference.title
                  • Reference.to_dict()
                  • Reference.to_json()
                  • Reference.to_str()
                  • Reference.type
              • pds.api_client.models.summary module
                • Summary
                  • Summary.facets
                  • Summary.from_dict()
                  • Summary.from_json()
                  • Summary.hits
                  • Summary.limit
                  • Summary.model_config
                  • Summary.properties
                  • Summary.q
                  • Summary.search_after
                  • Summary.sort
                  • Summary.to_dict()
                  • Summary.to_json()
                  • Summary.to_str()
                  • Summary.took
              • pds.api_client.models.wyriwyg_product module
                • WyriwygProduct
                  • WyriwygProduct.from_dict()
                  • WyriwygProduct.from_json()
                  • WyriwygProduct.key_value_pairs
                  • WyriwygProduct.model_config
                  • WyriwygProduct.to_dict()
                  • WyriwygProduct.to_json()
                  • WyriwygProduct.to_str()
              • pds.api_client.models.wyriwyg_product_key_value_pair module
                • WyriwygProductKeyValuePair
                  • WyriwygProductKeyValuePair.from_dict()
                  • WyriwygProductKeyValuePair.from_json()
                  • WyriwygProductKeyValuePair.key
                  • WyriwygProductKeyValuePair.model_config
                  • WyriwygProductKeyValuePair.to_dict()
                  • WyriwygProductKeyValuePair.to_json()
                  • WyriwygProductKeyValuePair.to_str()
                  • WyriwygProductKeyValuePair.value
              • pds.api_client.models.wyriwyg_products module
                • WyriwygProducts
                  • WyriwygProducts.data
                  • WyriwygProducts.from_dict()
                  • WyriwygProducts.from_json()
                  • WyriwygProducts.model_config
                  • WyriwygProducts.summary
                  • WyriwygProducts.to_dict()
                  • WyriwygProducts.to_json()
                  • WyriwygProducts.to_str()
            • Module contents
        • Submodules
          • pds.api_client.api_client module
            • ApiClient
              • ApiClient.NATIVE_TYPES_MAPPING
              • ApiClient.PRIMITIVE_TYPES
              • ApiClient.call_api()
              • ApiClient.deserialize()
              • ApiClient.files_parameters()
              • ApiClient.get_default()
              • ApiClient.param_serialize()
              • ApiClient.parameters_to_tuples()
              • ApiClient.parameters_to_url_query()
              • ApiClient.response_deserialize()
              • ApiClient.sanitize_for_serialization()
              • ApiClient.select_header_accept()
              • ApiClient.select_header_content_type()
              • ApiClient.set_default()
              • ApiClient.set_default_header()
              • ApiClient.update_params_for_auth()
              • ApiClient.user_agent
          • pds.api_client.api_response module
            • ApiResponse
              • ApiResponse.data
              • ApiResponse.headers
              • ApiResponse.model_config
              • ApiResponse.raw_data
              • ApiResponse.status_code
          • pds.api_client.configuration module
            • APIKeyAuthSetting
              • APIKeyAuthSetting.in
              • APIKeyAuthSetting.key
              • APIKeyAuthSetting.type
              • APIKeyAuthSetting.value
            • AuthSettings
            • BasicAuthSetting
              • BasicAuthSetting.in
              • BasicAuthSetting.key
              • BasicAuthSetting.type
              • BasicAuthSetting.value
            • BearerAuthSetting
              • BearerAuthSetting.in
              • BearerAuthSetting.key
              • BearerAuthSetting.type
              • BearerAuthSetting.value
            • BearerFormatAuthSetting
              • BearerFormatAuthSetting.format
              • BearerFormatAuthSetting.in
              • BearerFormatAuthSetting.key
              • BearerFormatAuthSetting.type
              • BearerFormatAuthSetting.value
            • Configuration
              • Configuration.access_token
              • Configuration.assert_hostname
              • Configuration.auth_settings()
              • Configuration.cert_file
              • Configuration.connection_pool_maxsize
              • Configuration.date_format
              • Configuration.datetime_format
              • Configuration.debug
              • Configuration.get_api_key_with_prefix()
              • Configuration.get_basic_auth_token()
              • Configuration.get_default()
              • Configuration.get_default_copy()
              • Configuration.get_host_from_settings()
              • Configuration.get_host_settings()
              • Configuration.host
              • Configuration.ignore_operation_servers
              • Configuration.key_file
              • Configuration.logger
              • Configuration.logger_file
              • Configuration.logger_file_handler
              • Configuration.logger_format
              • Configuration.logger_stream_handler
              • Configuration.password
              • Configuration.proxy
              • Configuration.proxy_headers
              • Configuration.refresh_api_key_hook
              • Configuration.retries
              • Configuration.safe_chars_for_path_param
              • Configuration.server_operation_index
              • Configuration.server_operation_variables
              • Configuration.set_default()
              • Configuration.socket_options
              • Configuration.ssl_ca_cert
              • Configuration.temp_folder_path
              • Configuration.tls_server_name
              • Configuration.to_debug_report()
              • Configuration.username
              • Configuration.verify_ssl
            • GenericAuthSetting
              • GenericAuthSetting.in
              • GenericAuthSetting.key
              • GenericAuthSetting.type
              • GenericAuthSetting.value
            • HTTPSignatureAuthSetting
              • HTTPSignatureAuthSetting.in
              • HTTPSignatureAuthSetting.key
              • HTTPSignatureAuthSetting.type
              • HTTPSignatureAuthSetting.value
            • HostSetting
              • HostSetting.description
              • HostSetting.url
              • HostSetting.variables
            • HostSettingVariable
              • HostSettingVariable.default_value
              • HostSettingVariable.description
              • HostSettingVariable.enum_values
            • OAuth2AuthSetting
              • OAuth2AuthSetting.in
              • OAuth2AuthSetting.key
              • OAuth2AuthSetting.type
              • OAuth2AuthSetting.value
          • pds.api_client.exceptions module
            • ApiAttributeError
            • ApiException
              • ApiException.from_response()
            • ApiKeyError
            • ApiTypeError
            • ApiValueError
            • BadRequestException
            • ForbiddenException
            • NotFoundException
            • OpenApiException
            • ServiceException
            • UnauthorizedException
            • render_path()
          • pds.api_client.rest module
            • RESTClientObject
              • RESTClientObject.request()
            • RESTResponse
              • RESTResponse.getheader()
              • RESTResponse.getheaders()
              • RESTResponse.read()
            • is_socks_proxy_url()
        • Module contents
    • Module contents
• Developer Notes
  • Requisites
  • Procedure
    • Get Repository Updates
    • Generate the Library
    • Installation & Testing
    • Run demo
    • PyPI Publication
    • Documentation Generation
• Contact Us
• Contribute
  • Request a New Tool / Service
  • Report a Bug